/**
* 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 { FuelEnergyGetFuelEnergyDriverReportsResponseBody } from '../samsara-models';
import { FuelEnergyGetFuelEnergyVehicleReportsResponseBody } from '../samsara-models';
import { FuelPurchasePostFuelPurchaseRequestBody } from '../samsara-models';
import { FuelPurchasePostFuelPurchaseResponseBody } from '../samsara-models';
/**
* FuelAndEnergyApi - axios parameter creator
* @export
*/
export declare const FuelAndEnergyApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get fuel and energy efficiency driver reports for the requested time range. Rate limit: 5 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 fuel and energy efficiency driver reports.
* @param {string} startDate A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @param {string} endDate An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @param {Array} [driverIds] A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @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 {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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFuelEnergyDriverReports: (startDate: string, endDate: string, driverIds?: Array, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get fuel and energy efficiency vehicle reports for the requested time range. 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 fuel and energy efficiency vehicle reports.
* @param {string} startDate A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @param {string} endDate An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @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 {GetFuelEnergyVehicleReportsEnergyTypeEnum} [energyType] The type of energy used by the vehicle. Valid values: `fuel`, `hybrid`, `electric`
* @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 {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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFuelEnergyVehicleReports: (startDate: string, endDate: string, vehicleIds?: string, energyType?: GetFuelEnergyVehicleReportsEnergyTypeEnum, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Create a fuel purchase transaction. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Fuel Purchase** 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 Create a fuel purchase transaction.
* @param {FuelPurchasePostFuelPurchaseRequestBody} postFuelPurchaseRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postFuelPurchase: (postFuelPurchaseRequestBody: FuelPurchasePostFuelPurchaseRequestBody, options?: RawAxiosRequestConfig) => Promise;
};
/**
* FuelAndEnergyApi - functional programming interface
* @export
*/
export declare const FuelAndEnergyApiFp: (configuration?: Configuration) => {
/**
* Get fuel and energy efficiency driver reports for the requested time range. Rate limit: 5 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 fuel and energy efficiency driver reports.
* @param {string} startDate A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @param {string} endDate An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @param {Array} [driverIds] A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @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 {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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFuelEnergyDriverReports(startDate: string, endDate: string, driverIds?: Array, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get fuel and energy efficiency vehicle reports for the requested time range. 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 fuel and energy efficiency vehicle reports.
* @param {string} startDate A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @param {string} endDate An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @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 {GetFuelEnergyVehicleReportsEnergyTypeEnum} [energyType] The type of energy used by the vehicle. Valid values: `fuel`, `hybrid`, `electric`
* @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 {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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFuelEnergyVehicleReports(startDate: string, endDate: string, vehicleIds?: string, energyType?: GetFuelEnergyVehicleReportsEnergyTypeEnum, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Create a fuel purchase transaction. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Fuel Purchase** 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 Create a fuel purchase transaction.
* @param {FuelPurchasePostFuelPurchaseRequestBody} postFuelPurchaseRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postFuelPurchase(postFuelPurchaseRequestBody: FuelPurchasePostFuelPurchaseRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* FuelAndEnergyApi - factory interface
* @export
*/
export declare const FuelAndEnergyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get fuel and energy efficiency driver reports for the requested time range. Rate limit: 5 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 fuel and energy efficiency driver reports.
* @param {FuelAndEnergyApiGetFuelEnergyDriverReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFuelEnergyDriverReports(requestParameters: FuelAndEnergyApiGetFuelEnergyDriverReportsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get fuel and energy efficiency vehicle reports for the requested time range. 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 fuel and energy efficiency vehicle reports.
* @param {FuelAndEnergyApiGetFuelEnergyVehicleReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFuelEnergyVehicleReports(requestParameters: FuelAndEnergyApiGetFuelEnergyVehicleReportsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Create a fuel purchase transaction. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Fuel Purchase** 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 Create a fuel purchase transaction.
* @param {FuelAndEnergyApiPostFuelPurchaseRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postFuelPurchase(requestParameters: FuelAndEnergyApiPostFuelPurchaseRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for getFuelEnergyDriverReports operation in FuelAndEnergyApi.
* @export
* @interface FuelAndEnergyApiGetFuelEnergyDriverReportsRequest
*/
export interface FuelAndEnergyApiGetFuelEnergyDriverReportsRequest {
/**
* A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @type {string}
* @memberof FuelAndEnergyApiGetFuelEnergyDriverReports
*/
readonly startDate: string;
/**
* An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @type {string}
* @memberof FuelAndEnergyApiGetFuelEnergyDriverReports
*/
readonly endDate: string;
/**
* A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @type {Array}
* @memberof FuelAndEnergyApiGetFuelEnergyDriverReports
*/
readonly driverIds?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {string}
* @memberof FuelAndEnergyApiGetFuelEnergyDriverReports
*/
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 FuelAndEnergyApiGetFuelEnergyDriverReports
*/
readonly parentTagIds?: 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 FuelAndEnergyApiGetFuelEnergyDriverReports
*/
readonly after?: string;
}
/**
* Request parameters for getFuelEnergyVehicleReports operation in FuelAndEnergyApi.
* @export
* @interface FuelAndEnergyApiGetFuelEnergyVehicleReportsRequest
*/
export interface FuelAndEnergyApiGetFuelEnergyVehicleReportsRequest {
/**
* A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @type {string}
* @memberof FuelAndEnergyApiGetFuelEnergyVehicleReports
*/
readonly startDate: string;
/**
* An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. 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. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.
* @type {string}
* @memberof FuelAndEnergyApiGetFuelEnergyVehicleReports
*/
readonly endDate: string;
/**
* 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 FuelAndEnergyApiGetFuelEnergyVehicleReports
*/
readonly vehicleIds?: string;
/**
* The type of energy used by the vehicle. Valid values: `fuel`, `hybrid`, `electric`
* @type {'fuel' | 'hybrid' | 'electric'}
* @memberof FuelAndEnergyApiGetFuelEnergyVehicleReports
*/
readonly energyType?: GetFuelEnergyVehicleReportsEnergyTypeEnum;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {string}
* @memberof FuelAndEnergyApiGetFuelEnergyVehicleReports
*/
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 FuelAndEnergyApiGetFuelEnergyVehicleReports
*/
readonly parentTagIds?: 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 FuelAndEnergyApiGetFuelEnergyVehicleReports
*/
readonly after?: string;
}
/**
* Request parameters for postFuelPurchase operation in FuelAndEnergyApi.
* @export
* @interface FuelAndEnergyApiPostFuelPurchaseRequest
*/
export interface FuelAndEnergyApiPostFuelPurchaseRequest {
/**
*
* @type {FuelPurchasePostFuelPurchaseRequestBody}
* @memberof FuelAndEnergyApiPostFuelPurchase
*/
readonly postFuelPurchaseRequestBody: FuelPurchasePostFuelPurchaseRequestBody;
}
/**
* FuelAndEnergyApi - object-oriented interface
* @export
* @class FuelAndEnergyApi
* @extends {BaseAPI}
*/
export declare class FuelAndEnergyApi extends BaseAPI {
/**
* Get fuel and energy efficiency driver reports for the requested time range. Rate limit: 5 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 fuel and energy efficiency driver reports.
* @param {FuelAndEnergyApiGetFuelEnergyDriverReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuelAndEnergyApi
*/
getFuelEnergyDriverReports(requestParameters: FuelAndEnergyApiGetFuelEnergyDriverReportsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get fuel and energy efficiency vehicle reports for the requested time range. 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 fuel and energy efficiency vehicle reports.
* @param {FuelAndEnergyApiGetFuelEnergyVehicleReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuelAndEnergyApi
*/
getFuelEnergyVehicleReports(requestParameters: FuelAndEnergyApiGetFuelEnergyVehicleReportsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Create a fuel purchase transaction. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Fuel Purchase** 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 Create a fuel purchase transaction.
* @param {FuelAndEnergyApiPostFuelPurchaseRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FuelAndEnergyApi
*/
postFuelPurchase(requestParameters: FuelAndEnergyApiPostFuelPurchaseRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const GetFuelEnergyVehicleReportsEnergyTypeEnum: {
readonly Fuel: "fuel";
readonly Hybrid: "hybrid";
readonly Electric: "electric";
};
export type GetFuelEnergyVehicleReportsEnergyTypeEnum = typeof GetFuelEnergyVehicleReportsEnergyTypeEnum[keyof typeof GetFuelEnergyVehicleReportsEnergyTypeEnum];