/**
* 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 { VehicleLocationsListResponse } from '../samsara-models';
import { VehicleLocationsResponse } from '../samsara-models';
/**
* VehicleLocationsApi - axios parameter creator
* @export
*/
export declare const VehicleLocationsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestats) instead.*** Returns the last known location of all vehicles at the given `time`. If no `time` is specified, the current time is used. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More.
* @summary Locations snapshot
* @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 {string} [time] A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Example: `2020-01-27T07:06:25Z`).
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleLocations: (after?: string, time?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatsfeed) instead.*** Follow a continuous feed of all vehicle locations from Samsara Vehicle Gateways. Your first call to this endpoint will provide you with the most recent location for each vehicle and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to the `after` parameter of this endpoint to get location updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. We\'d suggest waiting a minimum of 5 seconds before requesting updates. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.
* @summary Locations feed
* @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 {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleLocationsFeed: (after?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatshistory) instead.*** Returns all known vehicle locations during the given time range. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.
* @summary Historical locations
* @param {string} startTime A start 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).
* @param {string} endTime An end 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).
* @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 {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleLocationsHistory: (startTime: string, endTime: string, after?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, options?: RawAxiosRequestConfig) => Promise;
};
/**
* VehicleLocationsApi - functional programming interface
* @export
*/
export declare const VehicleLocationsApiFp: (configuration?: Configuration) => {
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestats) instead.*** Returns the last known location of all vehicles at the given `time`. If no `time` is specified, the current time is used. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More.
* @summary Locations snapshot
* @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 {string} [time] A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Example: `2020-01-27T07:06:25Z`).
* @param {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleLocations(after?: string, time?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatsfeed) instead.*** Follow a continuous feed of all vehicle locations from Samsara Vehicle Gateways. Your first call to this endpoint will provide you with the most recent location for each vehicle and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to the `after` parameter of this endpoint to get location updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. We\'d suggest waiting a minimum of 5 seconds before requesting updates. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.
* @summary Locations feed
* @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 {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleLocationsFeed(after?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatshistory) instead.*** Returns all known vehicle locations during the given time range. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.
* @summary Historical locations
* @param {string} startTime A start 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).
* @param {string} endTime An end 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).
* @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 {Array} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {Array} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleLocationsHistory(startTime: string, endTime: string, after?: string, parentTagIds?: Array, tagIds?: Array, vehicleIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* VehicleLocationsApi - factory interface
* @export
*/
export declare const VehicleLocationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestats) instead.*** Returns the last known location of all vehicles at the given `time`. If no `time` is specified, the current time is used. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More.
* @summary Locations snapshot
* @param {VehicleLocationsApiGetVehicleLocationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleLocations(requestParameters?: VehicleLocationsApiGetVehicleLocationsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatsfeed) instead.*** Follow a continuous feed of all vehicle locations from Samsara Vehicle Gateways. Your first call to this endpoint will provide you with the most recent location for each vehicle and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to the `after` parameter of this endpoint to get location updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. We\'d suggest waiting a minimum of 5 seconds before requesting updates. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.
* @summary Locations feed
* @param {VehicleLocationsApiGetVehicleLocationsFeedRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleLocationsFeed(requestParameters?: VehicleLocationsApiGetVehicleLocationsFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatshistory) instead.*** Returns all known vehicle locations during the given time range. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.
* @summary Historical locations
* @param {VehicleLocationsApiGetVehicleLocationsHistoryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleLocationsHistory(requestParameters: VehicleLocationsApiGetVehicleLocationsHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for getVehicleLocations operation in VehicleLocationsApi.
* @export
* @interface VehicleLocationsApiGetVehicleLocationsRequest
*/
export interface VehicleLocationsApiGetVehicleLocationsRequest {
/**
* 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 VehicleLocationsApiGetVehicleLocations
*/
readonly after?: string;
/**
* A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Example: `2020-01-27T07:06:25Z`).
* @type {string}
* @memberof VehicleLocationsApiGetVehicleLocations
*/
readonly time?: string;
/**
* A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @type {Array}
* @memberof VehicleLocationsApiGetVehicleLocations
*/
readonly parentTagIds?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {Array}
* @memberof VehicleLocationsApiGetVehicleLocations
*/
readonly tagIds?: Array;
/**
* A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`
* @type {Array}
* @memberof VehicleLocationsApiGetVehicleLocations
*/
readonly vehicleIds?: Array;
}
/**
* Request parameters for getVehicleLocationsFeed operation in VehicleLocationsApi.
* @export
* @interface VehicleLocationsApiGetVehicleLocationsFeedRequest
*/
export interface VehicleLocationsApiGetVehicleLocationsFeedRequest {
/**
* 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 VehicleLocationsApiGetVehicleLocationsFeed
*/
readonly after?: string;
/**
* A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @type {Array}
* @memberof VehicleLocationsApiGetVehicleLocationsFeed
*/
readonly parentTagIds?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {Array}
* @memberof VehicleLocationsApiGetVehicleLocationsFeed
*/
readonly tagIds?: Array;
/**
* A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`
* @type {Array}
* @memberof VehicleLocationsApiGetVehicleLocationsFeed
*/
readonly vehicleIds?: Array;
}
/**
* Request parameters for getVehicleLocationsHistory operation in VehicleLocationsApi.
* @export
* @interface VehicleLocationsApiGetVehicleLocationsHistoryRequest
*/
export interface VehicleLocationsApiGetVehicleLocationsHistoryRequest {
/**
* A start 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 VehicleLocationsApiGetVehicleLocationsHistory
*/
readonly startTime: string;
/**
* An end 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 VehicleLocationsApiGetVehicleLocationsHistory
*/
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 VehicleLocationsApiGetVehicleLocationsHistory
*/
readonly after?: string;
/**
* A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @type {Array}
* @memberof VehicleLocationsApiGetVehicleLocationsHistory
*/
readonly parentTagIds?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {Array}
* @memberof VehicleLocationsApiGetVehicleLocationsHistory
*/
readonly tagIds?: Array;
/**
* A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`
* @type {Array}
* @memberof VehicleLocationsApiGetVehicleLocationsHistory
*/
readonly vehicleIds?: Array;
}
/**
* VehicleLocationsApi - object-oriented interface
* @export
* @class VehicleLocationsApi
* @extends {BaseAPI}
*/
export declare class VehicleLocationsApi extends BaseAPI {
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestats) instead.*** Returns the last known location of all vehicles at the given `time`. If no `time` is specified, the current time is used. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More.
* @summary Locations snapshot
* @param {VehicleLocationsApiGetVehicleLocationsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof VehicleLocationsApi
*/
getVehicleLocations(requestParameters?: VehicleLocationsApiGetVehicleLocationsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatsfeed) instead.*** Follow a continuous feed of all vehicle locations from Samsara Vehicle Gateways. Your first call to this endpoint will provide you with the most recent location for each vehicle and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to the `after` parameter of this endpoint to get location updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. We\'d suggest waiting a minimum of 5 seconds before requesting updates. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.
* @summary Locations feed
* @param {VehicleLocationsApiGetVehicleLocationsFeedRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof VehicleLocationsApi
*/
getVehicleLocationsFeed(requestParameters?: VehicleLocationsApiGetVehicleLocationsFeedRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* ***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatshistory) instead.*** Returns all known vehicle locations during the given time range. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.
* @summary Historical locations
* @param {VehicleLocationsApiGetVehicleLocationsHistoryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof VehicleLocationsApi
*/
getVehicleLocationsHistory(requestParameters: VehicleLocationsApiGetVehicleLocationsHistoryRequest, options?: RawAxiosRequestConfig): Promise>;
}