import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"; import * as core from "../../../../core/index.js"; import type * as Samsara from "../../../index.js"; export declare namespace EquipmentClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class EquipmentClient { protected readonly _options: NormalizedClientOptionsWithAuth; constructor(options?: EquipmentClient.Options); /** * Returns a list of all equipment in an organization. * * @param {Samsara.ListEquipmentRequest} request * @param {EquipmentClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.equipment.listEquipment() */ listEquipment(request?: Samsara.ListEquipmentRequest, requestOptions?: EquipmentClient.RequestOptions): core.HttpResponsePromise; private __listEquipment; /** * 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. * * @param {Samsara.GetEquipmentLocationsRequest} request * @param {EquipmentClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.equipment.getEquipmentLocations() */ getEquipmentLocations(request?: Samsara.GetEquipmentLocationsRequest, requestOptions?: EquipmentClient.RequestOptions): core.HttpResponsePromise; private __getEquipmentLocations; /** * Follow a continuous feed of all equipment locations. * * 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. * * @param {Samsara.GetEquipmentLocationsFeedRequest} request * @param {EquipmentClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.equipment.getEquipmentLocationsFeed() */ getEquipmentLocationsFeed(request?: Samsara.GetEquipmentLocationsFeedRequest, requestOptions?: EquipmentClient.RequestOptions): core.HttpResponsePromise; private __getEquipmentLocationsFeed; /** * 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. * * @param {Samsara.GetEquipmentLocationsHistoryRequest} request * @param {EquipmentClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.equipment.getEquipmentLocationsHistory({ * startTime: "startTime", * endTime: "endTime" * }) */ getEquipmentLocationsHistory(request: Samsara.GetEquipmentLocationsHistoryRequest, requestOptions?: EquipmentClient.RequestOptions): core.HttpResponsePromise; private __getEquipmentLocationsHistory; /** * 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. * * @param {Samsara.GetEquipmentStatsRequest} request * @param {EquipmentClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.equipment.getEquipmentStats() */ getEquipmentStats(request?: Samsara.GetEquipmentStatsRequest, requestOptions?: EquipmentClient.RequestOptions): core.HttpResponsePromise; private __getEquipmentStats; /** * Follow a continuous feed of all equipment stats. * * 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. * * @param {Samsara.GetEquipmentStatsFeedRequest} request * @param {EquipmentClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.equipment.getEquipmentStatsFeed() */ getEquipmentStatsFeed(request?: Samsara.GetEquipmentStatsFeedRequest, requestOptions?: EquipmentClient.RequestOptions): core.HttpResponsePromise; private __getEquipmentStatsFeed; /** * 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. * * @param {Samsara.GetEquipmentStatsHistoryRequest} request * @param {EquipmentClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.equipment.getEquipmentStatsHistory({ * startTime: "startTime", * endTime: "endTime" * }) */ getEquipmentStatsHistory(request: Samsara.GetEquipmentStatsHistoryRequest, requestOptions?: EquipmentClient.RequestOptions): core.HttpResponsePromise; private __getEquipmentStatsHistory; /** * 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. * * @param {Samsara.GetEquipmentRequest} request * @param {EquipmentClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.equipment.getEquipment({ * id: "id" * }) */ getEquipment(request: Samsara.GetEquipmentRequest, requestOptions?: EquipmentClient.RequestOptions): core.HttpResponsePromise; private __getEquipment; }