import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js"; import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js"; import * as core from "../../../../core/index.js"; import * as Samsara from "../../../index.js"; export declare namespace DriversClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class DriversClient { protected readonly _options: NormalizedClientOptionsWithAuth; constructor(options?: DriversClient.Options); /** * Get all drivers in 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 Drivers** under the Drivers category when creating or editing an API token. Learn More. * * @param {Samsara.ListDriversRequest} request * @param {DriversClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.drivers.list() */ list(request?: Samsara.ListDriversRequest, requestOptions?: DriversClient.RequestOptions): Promise>; /** * Add a driver to the 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 **Write Drivers** under the Drivers category when creating or editing an API token. Learn More. * * @param {Samsara.CreateDriverRequest} request * @param {DriversClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.drivers.create({ * name: "Susan Jones", * password: "aSecurePassword1234", * username: "SusanJones" * }) */ create(request: Samsara.CreateDriverRequest, requestOptions?: DriversClient.RequestOptions): core.HttpResponsePromise; private __create; /** * Sign out a driver from the Samsara Driver App * * To access this endpoint, your organization must have the Samsara Platform Premier license. * * Note: Sign out requests made while a logged-in driver does not have internet connection will not log the driver out. A success response will still be provided and the driver will be logged out once they have internet connection. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Driver Remote Signout** under the Drivers 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. * * @param {Samsara.DriverRemoteSignoutPostDriverRemoteSignoutRequestBody} request * @param {DriversClient.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Samsara.UnauthorizedError} * @throws {@link Samsara.NotFoundError} * @throws {@link Samsara.MethodNotAllowedError} * @throws {@link Samsara.ContentTooLargeError} * @throws {@link Samsara.TooManyRequestsError} * @throws {@link Samsara.InternalServerError} * @throws {@link Samsara.NotImplementedError} * @throws {@link Samsara.BadGatewayError} * @throws {@link Samsara.ServiceUnavailableError} * @throws {@link Samsara.GatewayTimeoutError} * * @example * await client.drivers.postDriverRemoteSignout({ * driverId: "12434" * }) */ postDriverRemoteSignout(request: Samsara.DriverRemoteSignoutPostDriverRemoteSignoutRequestBody, requestOptions?: DriversClient.RequestOptions): core.HttpResponsePromise; private __postDriverRemoteSignout; /** * Get information about a driver. * * **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 Drivers** under the Drivers category when creating or editing an API token. Learn More. * * @param {Samsara.GetDriversRequest} request * @param {DriversClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.drivers.get({ * id: "id" * }) */ get(request: Samsara.GetDriversRequest, requestOptions?: DriversClient.RequestOptions): core.HttpResponsePromise; private __get; /** * @param {Samsara.DeleteDriversRequest} request * @param {DriversClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.drivers.delete({ * id: "id" * }) */ delete(request: Samsara.DeleteDriversRequest, requestOptions?: DriversClient.RequestOptions): core.HttpResponsePromise; private __delete; /** * Update a specific driver's information. This can also be used to activate or de-activate a given driver by setting the driverActivationStatus field. If the driverActivationStatus field is 'deactivated' then the user can also specify the deactivatedAtTime. The deactivatedAtTime cannot be more than 6 months in the past and must not come before the dirver's latest active HOS log. It will be considered an error if deactivatedAtTime is provided with a driverActivationStatus of active. * * **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 **Write Drivers** under the Drivers category when creating or editing an API token. Learn More. * * @param {Samsara.UpdateDriverRequest} request * @param {DriversClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.drivers.update({ * id: "id" * }) */ update(request: Samsara.UpdateDriverRequest, requestOptions?: DriversClient.RequestOptions): core.HttpResponsePromise; private __update; }