/**
* 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 { IdlingReportsGetVehicleIdlingReportsResponseBody } from '../samsara-models';
/**
* IdlingApi - axios parameter creator
* @export
*/
export declare const IdlingApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get all vehicle idling reports for the requested time duration. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Fuel & Energy** under the Fuel & Energy 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 vehicle idling reports.
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (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. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (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 {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @param {string} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [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 {boolean} [isPtoActive] A filter on the data based on power take-off being active or inactive.
* @param {number} [minIdlingDurationMinutes] A filter on the data based on a minimum idling duration.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleIdlingReports: (startTime: string, endTime: string, after?: string, limit?: number, vehicleIds?: string, tagIds?: string, parentTagIds?: string, isPtoActive?: boolean, minIdlingDurationMinutes?: number, options?: RawAxiosRequestConfig) => Promise;
};
/**
* IdlingApi - functional programming interface
* @export
*/
export declare const IdlingApiFp: (configuration?: Configuration) => {
/**
* Get all vehicle idling reports for the requested time duration. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Fuel & Energy** under the Fuel & Energy 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 vehicle idling reports.
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (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. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (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 {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @param {string} [vehicleIds] A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [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 {boolean} [isPtoActive] A filter on the data based on power take-off being active or inactive.
* @param {number} [minIdlingDurationMinutes] A filter on the data based on a minimum idling duration.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleIdlingReports(startTime: string, endTime: string, after?: string, limit?: number, vehicleIds?: string, tagIds?: string, parentTagIds?: string, isPtoActive?: boolean, minIdlingDurationMinutes?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* IdlingApi - factory interface
* @export
*/
export declare const IdlingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get all vehicle idling reports for the requested time duration. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Fuel & Energy** under the Fuel & Energy 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 vehicle idling reports.
* @param {IdlingApiGetVehicleIdlingReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getVehicleIdlingReports(requestParameters: IdlingApiGetVehicleIdlingReportsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for getVehicleIdlingReports operation in IdlingApi.
* @export
* @interface IdlingApiGetVehicleIdlingReportsRequest
*/
export interface IdlingApiGetVehicleIdlingReportsRequest {
/**
* A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @type {string}
* @memberof IdlingApiGetVehicleIdlingReports
*/
readonly startTime: string;
/**
* An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @type {string}
* @memberof IdlingApiGetVehicleIdlingReports
*/
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 IdlingApiGetVehicleIdlingReports
*/
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 IdlingApiGetVehicleIdlingReports
*/
readonly limit?: number;
/**
* A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @type {string}
* @memberof IdlingApiGetVehicleIdlingReports
*/
readonly vehicleIds?: string;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {string}
* @memberof IdlingApiGetVehicleIdlingReports
*/
readonly tagIds?: 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 {string}
* @memberof IdlingApiGetVehicleIdlingReports
*/
readonly parentTagIds?: string;
/**
* A filter on the data based on power take-off being active or inactive.
* @type {boolean}
* @memberof IdlingApiGetVehicleIdlingReports
*/
readonly isPtoActive?: boolean;
/**
* A filter on the data based on a minimum idling duration.
* @type {number}
* @memberof IdlingApiGetVehicleIdlingReports
*/
readonly minIdlingDurationMinutes?: number;
}
/**
* IdlingApi - object-oriented interface
* @export
* @class IdlingApi
* @extends {BaseAPI}
*/
export declare class IdlingApi extends BaseAPI {
/**
* Get all vehicle idling reports for the requested time duration. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Fuel & Energy** under the Fuel & Energy 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 vehicle idling reports.
* @param {IdlingApiGetVehicleIdlingReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IdlingApi
*/
getVehicleIdlingReports(requestParameters: IdlingApiGetVehicleIdlingReportsRequest, options?: RawAxiosRequestConfig): Promise>;
}