/**
* 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 { IFTACreateIftaDetailJobRequestBody } from '../samsara-models';
import { IFTACreateIftaDetailJobResponseBody } from '../samsara-models';
import { IFTAGetIftaDetailJobResponseBody } from '../samsara-models';
import { IFTAGetIftaJurisdictionReportsResponseBody } from '../samsara-models';
import { IFTAGetIftaVehicleReportsResponseBody } from '../samsara-models';
/**
* IFTAApi - axios parameter creator
* @export
*/
export declare const IFTAApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Create a job to generate csv files of IFTA mileage segments. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write IFTA (US)** under the Compliance 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 job to generate csv files of IFTA mileage segments.
* @param {IFTACreateIftaDetailJobRequestBody} createIftaDetailJobRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createIftaDetailJob: (createIftaDetailJobRequestBody: IFTACreateIftaDetailJobRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Get information about an existing IFTA detail job. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 information about an existing IFTA detail job.
* @param {string} id ID of the requested job.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIftaDetailJob: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get all jurisdiction IFTA reports for the requested time duration. Data is returned in your organization\'s defined timezone. **Note:** 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. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 IFTA jurisdiction reports.
* @param {number} year The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`
* @param {GetIftaJurisdictionReportsMonthEnum} [month] The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`
* @param {GetIftaJurisdictionReportsQuarterEnum} [quarter] The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`
* @param {string} [jurisdictions] A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`
* @param {GetIftaJurisdictionReportsFuelTypeEnum} [fuelType] A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIftaJurisdictionReports: (year: number, month?: GetIftaJurisdictionReportsMonthEnum, quarter?: GetIftaJurisdictionReportsQuarterEnum, jurisdictions?: string, fuelType?: GetIftaJurisdictionReportsFuelTypeEnum, vehicleIds?: string, tagIds?: string, parentTagIds?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get all vehicle IFTA reports for the requested time duration. Data is returned in your organization\'s defined timezone. **Note:** 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. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 IFTA vehicle reports.
* @param {number} year The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`
* @param {GetIftaVehicleReportsMonthEnum} [month] The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`
* @param {GetIftaVehicleReportsQuarterEnum} [quarter] The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`
* @param {string} [jurisdictions] A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`
* @param {GetIftaVehicleReportsFuelTypeEnum} [fuelType] A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`
* @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 {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}
*/
getIftaVehicleReports: (year: number, month?: GetIftaVehicleReportsMonthEnum, quarter?: GetIftaVehicleReportsQuarterEnum, jurisdictions?: string, fuelType?: GetIftaVehicleReportsFuelTypeEnum, vehicleIds?: string, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
};
/**
* IFTAApi - functional programming interface
* @export
*/
export declare const IFTAApiFp: (configuration?: Configuration) => {
/**
* Create a job to generate csv files of IFTA mileage segments. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write IFTA (US)** under the Compliance 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 job to generate csv files of IFTA mileage segments.
* @param {IFTACreateIftaDetailJobRequestBody} createIftaDetailJobRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createIftaDetailJob(createIftaDetailJobRequestBody: IFTACreateIftaDetailJobRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get information about an existing IFTA detail job. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 information about an existing IFTA detail job.
* @param {string} id ID of the requested job.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIftaDetailJob(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get all jurisdiction IFTA reports for the requested time duration. Data is returned in your organization\'s defined timezone. **Note:** 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. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 IFTA jurisdiction reports.
* @param {number} year The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`
* @param {GetIftaJurisdictionReportsMonthEnum} [month] The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`
* @param {GetIftaJurisdictionReportsQuarterEnum} [quarter] The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`
* @param {string} [jurisdictions] A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`
* @param {GetIftaJurisdictionReportsFuelTypeEnum} [fuelType] A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIftaJurisdictionReports(year: number, month?: GetIftaJurisdictionReportsMonthEnum, quarter?: GetIftaJurisdictionReportsQuarterEnum, jurisdictions?: string, fuelType?: GetIftaJurisdictionReportsFuelTypeEnum, vehicleIds?: string, tagIds?: string, parentTagIds?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get all vehicle IFTA reports for the requested time duration. Data is returned in your organization\'s defined timezone. **Note:** 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. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 IFTA vehicle reports.
* @param {number} year The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`
* @param {GetIftaVehicleReportsMonthEnum} [month] The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`
* @param {GetIftaVehicleReportsQuarterEnum} [quarter] The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`
* @param {string} [jurisdictions] A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`
* @param {GetIftaVehicleReportsFuelTypeEnum} [fuelType] A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`
* @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 {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}
*/
getIftaVehicleReports(year: number, month?: GetIftaVehicleReportsMonthEnum, quarter?: GetIftaVehicleReportsQuarterEnum, jurisdictions?: string, fuelType?: GetIftaVehicleReportsFuelTypeEnum, vehicleIds?: string, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* IFTAApi - factory interface
* @export
*/
export declare const IFTAApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Create a job to generate csv files of IFTA mileage segments. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write IFTA (US)** under the Compliance 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 job to generate csv files of IFTA mileage segments.
* @param {IFTAApiCreateIftaDetailJobRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createIftaDetailJob(requestParameters: IFTAApiCreateIftaDetailJobRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get information about an existing IFTA detail job. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 information about an existing IFTA detail job.
* @param {IFTAApiGetIftaDetailJobRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIftaDetailJob(requestParameters: IFTAApiGetIftaDetailJobRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get all jurisdiction IFTA reports for the requested time duration. Data is returned in your organization\'s defined timezone. **Note:** 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. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 IFTA jurisdiction reports.
* @param {IFTAApiGetIftaJurisdictionReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIftaJurisdictionReports(requestParameters: IFTAApiGetIftaJurisdictionReportsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get all vehicle IFTA reports for the requested time duration. Data is returned in your organization\'s defined timezone. **Note:** 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. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 IFTA vehicle reports.
* @param {IFTAApiGetIftaVehicleReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIftaVehicleReports(requestParameters: IFTAApiGetIftaVehicleReportsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for createIftaDetailJob operation in IFTAApi.
* @export
* @interface IFTAApiCreateIftaDetailJobRequest
*/
export interface IFTAApiCreateIftaDetailJobRequest {
/**
*
* @type {IFTACreateIftaDetailJobRequestBody}
* @memberof IFTAApiCreateIftaDetailJob
*/
readonly createIftaDetailJobRequestBody: IFTACreateIftaDetailJobRequestBody;
}
/**
* Request parameters for getIftaDetailJob operation in IFTAApi.
* @export
* @interface IFTAApiGetIftaDetailJobRequest
*/
export interface IFTAApiGetIftaDetailJobRequest {
/**
* ID of the requested job.
* @type {string}
* @memberof IFTAApiGetIftaDetailJob
*/
readonly id: string;
}
/**
* Request parameters for getIftaJurisdictionReports operation in IFTAApi.
* @export
* @interface IFTAApiGetIftaJurisdictionReportsRequest
*/
export interface IFTAApiGetIftaJurisdictionReportsRequest {
/**
* The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`
* @type {number}
* @memberof IFTAApiGetIftaJurisdictionReports
*/
readonly year: number;
/**
* The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`
* @type {'January' | 'February' | 'March' | 'April' | 'May' | 'June' | 'July' | 'August' | 'September' | 'October' | 'November' | 'December'}
* @memberof IFTAApiGetIftaJurisdictionReports
*/
readonly month?: GetIftaJurisdictionReportsMonthEnum;
/**
* The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`
* @type {'Q1' | 'Q2' | 'Q3' | 'Q4'}
* @memberof IFTAApiGetIftaJurisdictionReports
*/
readonly quarter?: GetIftaJurisdictionReportsQuarterEnum;
/**
* A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`
* @type {string}
* @memberof IFTAApiGetIftaJurisdictionReports
*/
readonly jurisdictions?: string;
/**
* A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`
* @type {'Unspecified' | 'A55' | 'Biodiesel' | 'CompressedNaturalGas' | 'Diesel' | 'E85' | 'Electricity' | 'Ethanol' | 'Gasohol' | 'Gasoline' | 'Hydrogen' | 'LiquifiedNaturalGas' | 'M85' | 'Methanol' | 'Propane' | 'Other'}
* @memberof IFTAApiGetIftaJurisdictionReports
*/
readonly fuelType?: GetIftaJurisdictionReportsFuelTypeEnum;
/**
* 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 IFTAApiGetIftaJurisdictionReports
*/
readonly vehicleIds?: string;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {string}
* @memberof IFTAApiGetIftaJurisdictionReports
*/
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 IFTAApiGetIftaJurisdictionReports
*/
readonly parentTagIds?: string;
}
/**
* Request parameters for getIftaVehicleReports operation in IFTAApi.
* @export
* @interface IFTAApiGetIftaVehicleReportsRequest
*/
export interface IFTAApiGetIftaVehicleReportsRequest {
/**
* The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`
* @type {number}
* @memberof IFTAApiGetIftaVehicleReports
*/
readonly year: number;
/**
* The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`
* @type {'January' | 'February' | 'March' | 'April' | 'May' | 'June' | 'July' | 'August' | 'September' | 'October' | 'November' | 'December'}
* @memberof IFTAApiGetIftaVehicleReports
*/
readonly month?: GetIftaVehicleReportsMonthEnum;
/**
* The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`
* @type {'Q1' | 'Q2' | 'Q3' | 'Q4'}
* @memberof IFTAApiGetIftaVehicleReports
*/
readonly quarter?: GetIftaVehicleReportsQuarterEnum;
/**
* A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`
* @type {string}
* @memberof IFTAApiGetIftaVehicleReports
*/
readonly jurisdictions?: string;
/**
* A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`
* @type {'Unspecified' | 'A55' | 'Biodiesel' | 'CompressedNaturalGas' | 'Diesel' | 'E85' | 'Electricity' | 'Ethanol' | 'Gasohol' | 'Gasoline' | 'Hydrogen' | 'LiquifiedNaturalGas' | 'M85' | 'Methanol' | 'Propane' | 'Other'}
* @memberof IFTAApiGetIftaVehicleReports
*/
readonly fuelType?: GetIftaVehicleReportsFuelTypeEnum;
/**
* 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 IFTAApiGetIftaVehicleReports
*/
readonly vehicleIds?: string;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {string}
* @memberof IFTAApiGetIftaVehicleReports
*/
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 IFTAApiGetIftaVehicleReports
*/
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 IFTAApiGetIftaVehicleReports
*/
readonly after?: string;
}
/**
* IFTAApi - object-oriented interface
* @export
* @class IFTAApi
* @extends {BaseAPI}
*/
export declare class IFTAApi extends BaseAPI {
/**
* Create a job to generate csv files of IFTA mileage segments. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write IFTA (US)** under the Compliance 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 job to generate csv files of IFTA mileage segments.
* @param {IFTAApiCreateIftaDetailJobRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IFTAApi
*/
createIftaDetailJob(requestParameters: IFTAApiCreateIftaDetailJobRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get information about an existing IFTA detail job. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 information about an existing IFTA detail job.
* @param {IFTAApiGetIftaDetailJobRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IFTAApi
*/
getIftaDetailJob(requestParameters: IFTAApiGetIftaDetailJobRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get all jurisdiction IFTA reports for the requested time duration. Data is returned in your organization\'s defined timezone. **Note:** 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. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 IFTA jurisdiction reports.
* @param {IFTAApiGetIftaJurisdictionReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IFTAApi
*/
getIftaJurisdictionReports(requestParameters: IFTAApiGetIftaJurisdictionReportsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get all vehicle IFTA reports for the requested time duration. Data is returned in your organization\'s defined timezone. **Note:** 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. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (US)** under the Compliance 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 IFTA vehicle reports.
* @param {IFTAApiGetIftaVehicleReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof IFTAApi
*/
getIftaVehicleReports(requestParameters: IFTAApiGetIftaVehicleReportsRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const GetIftaJurisdictionReportsMonthEnum: {
readonly January: "January";
readonly February: "February";
readonly March: "March";
readonly April: "April";
readonly May: "May";
readonly June: "June";
readonly July: "July";
readonly August: "August";
readonly September: "September";
readonly October: "October";
readonly November: "November";
readonly December: "December";
};
export type GetIftaJurisdictionReportsMonthEnum = typeof GetIftaJurisdictionReportsMonthEnum[keyof typeof GetIftaJurisdictionReportsMonthEnum];
/**
* @export
*/
export declare const GetIftaJurisdictionReportsQuarterEnum: {
readonly Q1: "Q1";
readonly Q2: "Q2";
readonly Q3: "Q3";
readonly Q4: "Q4";
};
export type GetIftaJurisdictionReportsQuarterEnum = typeof GetIftaJurisdictionReportsQuarterEnum[keyof typeof GetIftaJurisdictionReportsQuarterEnum];
/**
* @export
*/
export declare const GetIftaJurisdictionReportsFuelTypeEnum: {
readonly Unspecified: "Unspecified";
readonly A55: "A55";
readonly Biodiesel: "Biodiesel";
readonly CompressedNaturalGas: "CompressedNaturalGas";
readonly Diesel: "Diesel";
readonly E85: "E85";
readonly Electricity: "Electricity";
readonly Ethanol: "Ethanol";
readonly Gasohol: "Gasohol";
readonly Gasoline: "Gasoline";
readonly Hydrogen: "Hydrogen";
readonly LiquifiedNaturalGas: "LiquifiedNaturalGas";
readonly M85: "M85";
readonly Methanol: "Methanol";
readonly Propane: "Propane";
readonly Other: "Other";
};
export type GetIftaJurisdictionReportsFuelTypeEnum = typeof GetIftaJurisdictionReportsFuelTypeEnum[keyof typeof GetIftaJurisdictionReportsFuelTypeEnum];
/**
* @export
*/
export declare const GetIftaVehicleReportsMonthEnum: {
readonly January: "January";
readonly February: "February";
readonly March: "March";
readonly April: "April";
readonly May: "May";
readonly June: "June";
readonly July: "July";
readonly August: "August";
readonly September: "September";
readonly October: "October";
readonly November: "November";
readonly December: "December";
};
export type GetIftaVehicleReportsMonthEnum = typeof GetIftaVehicleReportsMonthEnum[keyof typeof GetIftaVehicleReportsMonthEnum];
/**
* @export
*/
export declare const GetIftaVehicleReportsQuarterEnum: {
readonly Q1: "Q1";
readonly Q2: "Q2";
readonly Q3: "Q3";
readonly Q4: "Q4";
};
export type GetIftaVehicleReportsQuarterEnum = typeof GetIftaVehicleReportsQuarterEnum[keyof typeof GetIftaVehicleReportsQuarterEnum];
/**
* @export
*/
export declare const GetIftaVehicleReportsFuelTypeEnum: {
readonly Unspecified: "Unspecified";
readonly A55: "A55";
readonly Biodiesel: "Biodiesel";
readonly CompressedNaturalGas: "CompressedNaturalGas";
readonly Diesel: "Diesel";
readonly E85: "E85";
readonly Electricity: "Electricity";
readonly Ethanol: "Ethanol";
readonly Gasohol: "Gasohol";
readonly Gasoline: "Gasoline";
readonly Hydrogen: "Hydrogen";
readonly LiquifiedNaturalGas: "LiquifiedNaturalGas";
readonly M85: "M85";
readonly Methanol: "Methanol";
readonly Propane: "Propane";
readonly Other: "Other";
};
export type GetIftaVehicleReportsFuelTypeEnum = typeof GetIftaVehicleReportsFuelTypeEnum[keyof typeof GetIftaVehicleReportsFuelTypeEnum];