/** * 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 { EquipmentListResponse } from '../samsara-models'; import { EquipmentLocationsListResponse } from '../samsara-models'; import { EquipmentLocationsResponse } from '../samsara-models'; import { EquipmentResponse } from '../samsara-models'; import { EquipmentStatsListResponse } from '../samsara-models'; import { EquipmentStatsResponse } from '../samsara-models'; /** * EquipmentApi - axios parameter creator * @export */ export declare const EquipmentApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieves the unit of equipment with the given Samsara ID. **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 Equipment** under the Equipment category when creating or editing an API token. Learn More. * @summary Retrieve a unit of equipment * @param {string} id Samsara ID of the Equipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipment: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get most recent locations for all equipment * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentLocations: (after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Follow a continuous feed of all equipment locations from Samsara AG26s. Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment 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. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Follow feed of equipment locations * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentLocationsFeed: (after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get historical equipment 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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentLocationsHistory: (startTime: string, endTime: string, after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Returns the last known stats for all equipment. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get most recent stats for all equipment * @param {Array} types The types of equipment stats you want to query. Currently, you may submit up to 3 types. - `engineRpm`: The revolutions per minute of the engine. - `fuelPercents`: The percent of fuel in the unit of equipment. - `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics. - `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard. - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`. - `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`. - `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`. - `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling. * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentStats: (types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Follow a continuous feed of all equipment stats from Samsara AG26s. Your first call to this endpoint will provide you with the most recent stats for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment stats updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. Each stat type has a different refresh rate, but in general we\'d suggest waiting a minimum of 5 seconds before requesting updates. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Follow a feed of equipment stats * @param {Array} types The types of equipment stats you want to query. Currently, you may submit up to 3 types. - `engineRpm`: The revolutions per minute of the engine. - `fuelPercents`: The percent of fuel in the unit of equipment. - `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics. - `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard. - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`. - `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`. - `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`. - `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling. * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentStatsFeed: (types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Returns historical equipment status during the given time range. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get historical equipment stats * @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 {Array} types The types of equipment stats you want to query. Currently, you may submit up to 3 types. - `engineRpm`: The revolutions per minute of the engine. - `fuelPercents`: The percent of fuel in the unit of equipment. - `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics. - `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard. - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`. - `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`. - `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`. - `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling. * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentStatsHistory: (startTime: string, endTime: string, types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Returns a list of all equipment in an organization. Equipment objects represent powered assets connected to a [Samsara AG26](https://www.samsara.com/products/models/ag26) via an APWR, CAT, or J1939 cable. They are automatically created with a unique Samsara Equipment ID whenever an AG26 is activated in your organization. **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 Equipment** under the Equipment category when creating or editing an API token. Learn More. * @summary List all equipment * @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} [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 {*} [options] Override http request option. * @throws {RequiredError} */ listEquipment: (limit?: number, after?: string, parentTagIds?: Array, tagIds?: Array, options?: RawAxiosRequestConfig) => Promise; }; /** * EquipmentApi - functional programming interface * @export */ export declare const EquipmentApiFp: (configuration?: Configuration) => { /** * Retrieves the unit of equipment with the given Samsara ID. **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 Equipment** under the Equipment category when creating or editing an API token. Learn More. * @summary Retrieve a unit of equipment * @param {string} id Samsara ID of the Equipment. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipment(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get most recent locations for all equipment * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentLocations(after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Follow a continuous feed of all equipment locations from Samsara AG26s. Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment 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. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Follow feed of equipment locations * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentLocationsFeed(after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get historical equipment 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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentLocationsHistory(startTime: string, endTime: string, after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the last known stats for all equipment. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get most recent stats for all equipment * @param {Array} types The types of equipment stats you want to query. Currently, you may submit up to 3 types. - `engineRpm`: The revolutions per minute of the engine. - `fuelPercents`: The percent of fuel in the unit of equipment. - `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics. - `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard. - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`. - `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`. - `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`. - `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling. * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentStats(types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Follow a continuous feed of all equipment stats from Samsara AG26s. Your first call to this endpoint will provide you with the most recent stats for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment stats updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. Each stat type has a different refresh rate, but in general we\'d suggest waiting a minimum of 5 seconds before requesting updates. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Follow a feed of equipment stats * @param {Array} types The types of equipment stats you want to query. Currently, you may submit up to 3 types. - `engineRpm`: The revolutions per minute of the engine. - `fuelPercents`: The percent of fuel in the unit of equipment. - `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics. - `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard. - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`. - `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`. - `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`. - `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling. * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentStatsFeed(types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns historical equipment status during the given time range. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get historical equipment stats * @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 {Array} types The types of equipment stats you want to query. Currently, you may submit up to 3 types. - `engineRpm`: The revolutions per minute of the engine. - `fuelPercents`: The percent of fuel in the unit of equipment. - `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics. - `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard. - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`. - `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`. - `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`. - `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling. * @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} [equipmentIds] A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentStatsHistory(startTime: string, endTime: string, types: Array, after?: string, parentTagIds?: Array, tagIds?: Array, equipmentIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a list of all equipment in an organization. Equipment objects represent powered assets connected to a [Samsara AG26](https://www.samsara.com/products/models/ag26) via an APWR, CAT, or J1939 cable. They are automatically created with a unique Samsara Equipment ID whenever an AG26 is activated in your organization. **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 Equipment** under the Equipment category when creating or editing an API token. Learn More. * @summary List all equipment * @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} [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 {*} [options] Override http request option. * @throws {RequiredError} */ listEquipment(limit?: number, after?: string, parentTagIds?: Array, tagIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * EquipmentApi - factory interface * @export */ export declare const EquipmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieves the unit of equipment with the given Samsara ID. **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 Equipment** under the Equipment category when creating or editing an API token. Learn More. * @summary Retrieve a unit of equipment * @param {EquipmentApiGetEquipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipment(requestParameters: EquipmentApiGetEquipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get most recent locations for all equipment * @param {EquipmentApiGetEquipmentLocationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentLocations(requestParameters?: EquipmentApiGetEquipmentLocationsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Follow a continuous feed of all equipment locations from Samsara AG26s. Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment 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. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Follow feed of equipment locations * @param {EquipmentApiGetEquipmentLocationsFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentLocationsFeed(requestParameters?: EquipmentApiGetEquipmentLocationsFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get historical equipment locations * @param {EquipmentApiGetEquipmentLocationsHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentLocationsHistory(requestParameters: EquipmentApiGetEquipmentLocationsHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the last known stats for all equipment. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get most recent stats for all equipment * @param {EquipmentApiGetEquipmentStatsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentStats(requestParameters: EquipmentApiGetEquipmentStatsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Follow a continuous feed of all equipment stats from Samsara AG26s. Your first call to this endpoint will provide you with the most recent stats for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment stats updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. Each stat type has a different refresh rate, but in general we\'d suggest waiting a minimum of 5 seconds before requesting updates. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Follow a feed of equipment stats * @param {EquipmentApiGetEquipmentStatsFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentStatsFeed(requestParameters: EquipmentApiGetEquipmentStatsFeedRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns historical equipment status during the given time range. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get historical equipment stats * @param {EquipmentApiGetEquipmentStatsHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEquipmentStatsHistory(requestParameters: EquipmentApiGetEquipmentStatsHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a list of all equipment in an organization. Equipment objects represent powered assets connected to a [Samsara AG26](https://www.samsara.com/products/models/ag26) via an APWR, CAT, or J1939 cable. They are automatically created with a unique Samsara Equipment ID whenever an AG26 is activated in your organization. **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 Equipment** under the Equipment category when creating or editing an API token. Learn More. * @summary List all equipment * @param {EquipmentApiListEquipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listEquipment(requestParameters?: EquipmentApiListEquipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getEquipment operation in EquipmentApi. * @export * @interface EquipmentApiGetEquipmentRequest */ export interface EquipmentApiGetEquipmentRequest { /** * Samsara ID of the Equipment. * @type {string} * @memberof EquipmentApiGetEquipment */ readonly id: string; } /** * Request parameters for getEquipmentLocations operation in EquipmentApi. * @export * @interface EquipmentApiGetEquipmentLocationsRequest */ export interface EquipmentApiGetEquipmentLocationsRequest { /** * 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 EquipmentApiGetEquipmentLocations */ 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 EquipmentApiGetEquipmentLocations */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentLocations */ readonly tagIds?: Array; /** * A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentLocations */ readonly equipmentIds?: Array; } /** * Request parameters for getEquipmentLocationsFeed operation in EquipmentApi. * @export * @interface EquipmentApiGetEquipmentLocationsFeedRequest */ export interface EquipmentApiGetEquipmentLocationsFeedRequest { /** * 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 EquipmentApiGetEquipmentLocationsFeed */ 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 EquipmentApiGetEquipmentLocationsFeed */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentLocationsFeed */ readonly tagIds?: Array; /** * A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentLocationsFeed */ readonly equipmentIds?: Array; } /** * Request parameters for getEquipmentLocationsHistory operation in EquipmentApi. * @export * @interface EquipmentApiGetEquipmentLocationsHistoryRequest */ export interface EquipmentApiGetEquipmentLocationsHistoryRequest { /** * 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 EquipmentApiGetEquipmentLocationsHistory */ 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 EquipmentApiGetEquipmentLocationsHistory */ 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 EquipmentApiGetEquipmentLocationsHistory */ 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 EquipmentApiGetEquipmentLocationsHistory */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentLocationsHistory */ readonly tagIds?: Array; /** * A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentLocationsHistory */ readonly equipmentIds?: Array; } /** * Request parameters for getEquipmentStats operation in EquipmentApi. * @export * @interface EquipmentApiGetEquipmentStatsRequest */ export interface EquipmentApiGetEquipmentStatsRequest { /** * The types of equipment stats you want to query. Currently, you may submit up to 3 types. - `engineRpm`: The revolutions per minute of the engine. - `fuelPercents`: The percent of fuel in the unit of equipment. - `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics. - `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard. - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`. - `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`. - `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`. - `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling. * @type {Array<'gatewayEngineStates' | 'obdEngineStates' | 'fuelPercents' | 'engineRpm' | 'gatewayEngineSeconds' | 'obdEngineSeconds' | 'gatewayJ1939EngineSeconds' | 'gpsOdometerMeters' | 'gps' | 'engineTotalIdleTimeMinutes'>} * @memberof EquipmentApiGetEquipmentStats */ readonly types: Array; /** * 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 EquipmentApiGetEquipmentStats */ 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 EquipmentApiGetEquipmentStats */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentStats */ readonly tagIds?: Array; /** * A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentStats */ readonly equipmentIds?: Array; } /** * Request parameters for getEquipmentStatsFeed operation in EquipmentApi. * @export * @interface EquipmentApiGetEquipmentStatsFeedRequest */ export interface EquipmentApiGetEquipmentStatsFeedRequest { /** * The types of equipment stats you want to query. Currently, you may submit up to 3 types. - `engineRpm`: The revolutions per minute of the engine. - `fuelPercents`: The percent of fuel in the unit of equipment. - `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics. - `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard. - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`. - `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`. - `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`. - `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling. * @type {Array<'gatewayEngineStates' | 'obdEngineStates' | 'fuelPercents' | 'engineRpm' | 'gatewayEngineSeconds' | 'obdEngineSeconds' | 'gatewayJ1939EngineSeconds' | 'gpsOdometerMeters' | 'gps' | 'engineTotalIdleTimeMinutes'>} * @memberof EquipmentApiGetEquipmentStatsFeed */ readonly types: Array; /** * 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 EquipmentApiGetEquipmentStatsFeed */ 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 EquipmentApiGetEquipmentStatsFeed */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentStatsFeed */ readonly tagIds?: Array; /** * A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentStatsFeed */ readonly equipmentIds?: Array; } /** * Request parameters for getEquipmentStatsHistory operation in EquipmentApi. * @export * @interface EquipmentApiGetEquipmentStatsHistoryRequest */ export interface EquipmentApiGetEquipmentStatsHistoryRequest { /** * 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 EquipmentApiGetEquipmentStatsHistory */ 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 EquipmentApiGetEquipmentStatsHistory */ readonly endTime: string; /** * The types of equipment stats you want to query. Currently, you may submit up to 3 types. - `engineRpm`: The revolutions per minute of the engine. - `fuelPercents`: The percent of fuel in the unit of equipment. - `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics. - `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). - `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard. - `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`. - `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`. - `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`. - `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. - `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling. * @type {Array<'gatewayEngineStates' | 'obdEngineStates' | 'fuelPercents' | 'engineRpm' | 'gatewayEngineSeconds' | 'obdEngineSeconds' | 'gatewayJ1939EngineSeconds' | 'gpsOdometerMeters' | 'gps' | 'engineTotalIdleTimeMinutes'>} * @memberof EquipmentApiGetEquipmentStatsHistory */ readonly types: Array; /** * 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 EquipmentApiGetEquipmentStatsHistory */ 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 EquipmentApiGetEquipmentStatsHistory */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentStatsHistory */ readonly tagIds?: Array; /** * A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678` * @type {Array} * @memberof EquipmentApiGetEquipmentStatsHistory */ readonly equipmentIds?: Array; } /** * Request parameters for listEquipment operation in EquipmentApi. * @export * @interface EquipmentApiListEquipmentRequest */ export interface EquipmentApiListEquipmentRequest { /** * The limit for how many objects will be in the response. Default and max for this value is 512 objects. * @type {number} * @memberof EquipmentApiListEquipment */ readonly limit?: number; /** * 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 EquipmentApiListEquipment */ 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 EquipmentApiListEquipment */ readonly parentTagIds?: Array; /** * A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678` * @type {Array} * @memberof EquipmentApiListEquipment */ readonly tagIds?: Array; } /** * EquipmentApi - object-oriented interface * @export * @class EquipmentApi * @extends {BaseAPI} */ export declare class EquipmentApi extends BaseAPI { /** * Retrieves the unit of equipment with the given Samsara ID. **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 Equipment** under the Equipment category when creating or editing an API token. Learn More. * @summary Retrieve a unit of equipment * @param {EquipmentApiGetEquipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EquipmentApi */ getEquipment(requestParameters: EquipmentApiGetEquipmentRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get most recent locations for all equipment * @param {EquipmentApiGetEquipmentLocationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EquipmentApi */ getEquipmentLocations(requestParameters?: EquipmentApiGetEquipmentLocationsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Follow a continuous feed of all equipment locations from Samsara AG26s. Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment 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. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Follow feed of equipment locations * @param {EquipmentApiGetEquipmentLocationsFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EquipmentApi */ getEquipmentLocationsFeed(requestParameters?: EquipmentApiGetEquipmentLocationsFeedRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs. **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get historical equipment locations * @param {EquipmentApiGetEquipmentLocationsHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EquipmentApi */ getEquipmentLocationsHistory(requestParameters: EquipmentApiGetEquipmentLocationsHistoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns the last known stats for all equipment. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get most recent stats for all equipment * @param {EquipmentApiGetEquipmentStatsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EquipmentApi */ getEquipmentStats(requestParameters: EquipmentApiGetEquipmentStatsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Follow a continuous feed of all equipment stats from Samsara AG26s. Your first call to this endpoint will provide you with the most recent stats for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment stats updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. Each stat type has a different refresh rate, but in general we\'d suggest waiting a minimum of 5 seconds before requesting updates. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Follow a feed of equipment stats * @param {EquipmentApiGetEquipmentStatsFeedRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EquipmentApi */ getEquipmentStatsFeed(requestParameters: EquipmentApiGetEquipmentStatsFeedRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns historical equipment status during the given time range. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **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 Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More. * @summary Get historical equipment stats * @param {EquipmentApiGetEquipmentStatsHistoryRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EquipmentApi */ getEquipmentStatsHistory(requestParameters: EquipmentApiGetEquipmentStatsHistoryRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns a list of all equipment in an organization. Equipment objects represent powered assets connected to a [Samsara AG26](https://www.samsara.com/products/models/ag26) via an APWR, CAT, or J1939 cable. They are automatically created with a unique Samsara Equipment ID whenever an AG26 is activated in your organization. **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 Equipment** under the Equipment category when creating or editing an API token. Learn More. * @summary List all equipment * @param {EquipmentApiListEquipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof EquipmentApi */ listEquipment(requestParameters?: EquipmentApiListEquipmentRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetEquipmentStatsTypesEnum: { readonly GatewayEngineStates: "gatewayEngineStates"; readonly ObdEngineStates: "obdEngineStates"; readonly FuelPercents: "fuelPercents"; readonly EngineRpm: "engineRpm"; readonly GatewayEngineSeconds: "gatewayEngineSeconds"; readonly ObdEngineSeconds: "obdEngineSeconds"; readonly GatewayJ1939EngineSeconds: "gatewayJ1939EngineSeconds"; readonly GpsOdometerMeters: "gpsOdometerMeters"; readonly Gps: "gps"; readonly EngineTotalIdleTimeMinutes: "engineTotalIdleTimeMinutes"; }; export type GetEquipmentStatsTypesEnum = typeof GetEquipmentStatsTypesEnum[keyof typeof GetEquipmentStatsTypesEnum]; /** * @export */ export declare const GetEquipmentStatsFeedTypesEnum: { readonly GatewayEngineStates: "gatewayEngineStates"; readonly ObdEngineStates: "obdEngineStates"; readonly FuelPercents: "fuelPercents"; readonly EngineRpm: "engineRpm"; readonly GatewayEngineSeconds: "gatewayEngineSeconds"; readonly ObdEngineSeconds: "obdEngineSeconds"; readonly GatewayJ1939EngineSeconds: "gatewayJ1939EngineSeconds"; readonly GpsOdometerMeters: "gpsOdometerMeters"; readonly Gps: "gps"; readonly EngineTotalIdleTimeMinutes: "engineTotalIdleTimeMinutes"; }; export type GetEquipmentStatsFeedTypesEnum = typeof GetEquipmentStatsFeedTypesEnum[keyof typeof GetEquipmentStatsFeedTypesEnum]; /** * @export */ export declare const GetEquipmentStatsHistoryTypesEnum: { readonly GatewayEngineStates: "gatewayEngineStates"; readonly ObdEngineStates: "obdEngineStates"; readonly FuelPercents: "fuelPercents"; readonly EngineRpm: "engineRpm"; readonly GatewayEngineSeconds: "gatewayEngineSeconds"; readonly ObdEngineSeconds: "obdEngineSeconds"; readonly GatewayJ1939EngineSeconds: "gatewayJ1939EngineSeconds"; readonly GpsOdometerMeters: "gpsOdometerMeters"; readonly Gps: "gps"; readonly EngineTotalIdleTimeMinutes: "engineTotalIdleTimeMinutes"; }; export type GetEquipmentStatsHistoryTypesEnum = typeof GetEquipmentStatsHistoryTypesEnum[keyof typeof GetEquipmentStatsHistoryTypesEnum];