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 PreviewApIsClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class PreviewApIsClient { protected readonly _options: NormalizedClientOptionsWithAuth; constructor(options?: PreviewApIsClient.Options); /** * Creates a short-lived auth token for a driver. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Driver Auth Token** under the Drivers category when creating or editing an API token. Learn More. * * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications * * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. * * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). * * * **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.DriversAuthTokenCreateDriverAuthTokenRequestBody} request * @param {PreviewApIsClient.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.previewApIs.createDriverAuthToken({ * code: "dp[gZc1wAigz4uGa0Hh" * }) */ createDriverAuthToken(request: Samsara.DriversAuthTokenCreateDriverAuthTokenRequestBody, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise; private __createDriverAuthToken; /** * Returns current canonical order state for up to 100 supplied order IDs. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications * * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. * * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). * * * **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.GetOrdersRequest} request * @param {PreviewApIsClient.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.previewApIs.getOrders() */ getOrders(request?: Samsara.GetOrdersRequest, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise; private __getOrders; /** * Deletes one canonical order by Samsara UUID or external ID. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications * * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. * * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). * * * **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.DeleteOrderRequest} request * @param {PreviewApIsClient.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.previewApIs.deleteOrder({ * orderId: "orderId" * }) */ deleteOrder(request: Samsara.DeleteOrderRequest, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteOrder; /** * Atomically creates or updates up to 250 canonical orders. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications * * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. * * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). * * * **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.OrdersPostOrdersBatchRequestBody} request * @param {PreviewApIsClient.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.previewApIs.postOrdersBatch({ * data: [{}] * }) */ postOrdersBatch(request: Samsara.OrdersPostOrdersBatchRequestBody, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise; private __postOrdersBatch; /** * Returns deletion markers for order replication. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications * * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. * * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). * * * **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.GetOrderDeletionsRequest} request * @param {PreviewApIsClient.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.previewApIs.getOrderDeletions() */ getOrderDeletions(request?: Samsara.GetOrderDeletionsRequest, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise; private __getOrderDeletions; /** * Returns live order create and update state for replication. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. * * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications * * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. * * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). * * * **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.GetOrdersStreamRequest} request * @param {PreviewApIsClient.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.previewApIs.getOrdersStream({ * startTime: "2024-01-15T09:30:00Z" * }) */ getOrdersStream(request: Samsara.GetOrdersStreamRequest, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise; private __getOrdersStream; /** * Lock a vehicle. This requires a vehicle gateway with locking capabilities. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Vehicle Lock/Unlock** under the Vehicles category when creating or editing an API token. Learn More. * * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications * * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. * * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). * * * **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.LockVehicleRequest} request * @param {PreviewApIsClient.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.previewApIs.lockVehicle({ * id: "id" * }) */ lockVehicle(request: Samsara.LockVehicleRequest, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise; private __lockVehicle; /** * Unlock a vehicle. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Vehicle Lock/Unlock** under the Vehicles category when creating or editing an API token. Learn More. * * Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications * * - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. * * - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). * * * **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.UnlockVehicleRequest} request * @param {PreviewApIsClient.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.previewApIs.unlockVehicle({ * id: "id" * }) */ unlockVehicle(request: Samsara.UnlockVehicleRequest, requestOptions?: PreviewApIsClient.RequestOptions): core.HttpResponsePromise; private __unlockVehicle; }