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 BetaApIsClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class BetaApIsClient { protected readonly _options: NormalizedClientOptionsWithAuth; constructor(options?: BetaApIsClient.Options); /** * Returns full details — including the transcript, tool calls, lifecycle events, and a recording URL — for a batch of voice agent sessions identified by `ids`. Discover session IDs with GET /agent-studio/voice-sessions/stream. Up to 100 IDs may be requested per call; IDs that are not found are omitted from the response. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Agent Studio Voice Sessions** under the Closed Beta 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.GetVoiceSessionsRequest} request * @param {BetaApIsClient.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.betaApIs.getVoiceSessions() */ getVoiceSessions(request?: Samsara.GetVoiceSessionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getVoiceSessions; /** * Returns a paginated stream of voice agent session summaries, filterable by start time, agent, vehicle, driver, and status. Sessions are returned ordered by `happenedAtTime` descending (most recent first). Use this endpoint to discover sessions; pass the returned IDs to GET /agent-studio/voice-sessions to fetch full session details. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Agent Studio Voice Sessions** under the Closed Beta 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.GetVoiceSessionsStreamRequest} request * @param {BetaApIsClient.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.betaApIs.getVoiceSessionsStream({ * startTime: "startTime" * }) */ getVoiceSessionsStream(request: Samsara.GetVoiceSessionsStreamRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getVoiceSessionsStream; /** * Returns depreciation and adjustment transactions for assets. Transactions are returned ordered by updatedAt in ascending order (oldest to newest). Use startTime parameter for incremental sync. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Assets** under the Assets 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.GetDepreciationTransactionsRequest} request * @param {BetaApIsClient.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.betaApIs.getDepreciationTransactions() */ getDepreciationTransactions(request?: Samsara.GetDepreciationTransactionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getDepreciationTransactions; /** * This endpoint will return data collected from the inputs of your organization's assets based on the time parameters passed in. Results are paginated. If you include an endTime, the endpoint will return data up until that point. If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. The endpoint will only return data up until the endTime that has been processed by the server at the time of the original request. You will need to request the same [startTime, endTime) range again to receive data for assets processed after the original request time. This endpoint sorts data by time ascending. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Assets** under the Assets 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.GetAssetsInputsRequest} request * @param {BetaApIsClient.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.betaApIs.getAssetsInputs({ * type: "auxInput1", * startTime: "startTime" * }) */ getAssetsInputs(request: Samsara.GetAssetsInputsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getAssetsInputs; /** * Get a list of equipment following the AEMP ISO 15143-3 standard. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read AEMP** under the Equipment 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.GetAempEquipmentListRequest} request * @param {BetaApIsClient.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.betaApIs.getAempEquipmentList({ * pageNumber: "pageNumber" * }) */ getAempEquipmentList(request: Samsara.GetAempEquipmentListRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getAempEquipmentList; /** * Get all driver and associated vehicle efficiency data. * * This is a legacy endpoint, consider using this endpoint [/driver-efficiency/drivers](https://developers.samsara.com/reference/getdriverefficiencybydrivers) instead. The endpoint will continue to function as documented. * * Rate limit: 50 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 Fuel & Energy** under the Fuel & Energy category when creating or editing an API token. Learn More. * * @param {Samsara.GetDriverEfficiencyRequest} request * @param {BetaApIsClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.betaApIs.getDriverEfficiency() */ getDriverEfficiency(request?: Samsara.GetDriverEfficiencyRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getDriverEfficiency; /** * Update an equipment. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard. * This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource. * For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Equipment** under the Equipment 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.EquipmentPatchEquipmentRequestBody} request * @param {BetaApIsClient.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.betaApIs.patchEquipment({ * id: "id" * }) */ patchEquipment(request: Samsara.EquipmentPatchEquipmentRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __patchEquipment; /** * Get all HOS ELD events in a time range, grouped by driver. Attributes will be populated depending on which ELD Event Type is being returned. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.GetHosEldEventsRequest} request * @param {BetaApIsClient.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.betaApIs.getHosEldEvents({ * startTime: "startTime", * endTime: "endTime" * }) */ getHosEldEvents(request: Samsara.GetHosEldEventsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getHosEldEvents; /** * Update the engine immobilizer state of a vehicle. This requires an engine immobilizer to be installed on the vehicle gateway. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Vehicle Immobilization** under the Vehicles 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.EngineImmobilizerUpdateEngineImmobilizerStateRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateEngineImmobilizerState({ * id: 1000000, * relayStates: [{ * id: "relay1", * isOpen: false * }] * }) */ updateEngineImmobilizerState(request: Samsara.EngineImmobilizerUpdateEngineImmobilizerStateRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateEngineImmobilizerState; /** * Fetches jobs based on id/uuid or provided filters. * * To use this endpoint, select **Read Jobs** under the Equipment 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.GetJobsRequest} request * @param {BetaApIsClient.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.betaApIs.getJobs() */ getJobs(request?: Samsara.GetJobsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getJobs; /** * Creates a new job and returns it. * * To use this endpoint, select **Write Jobs** under the Equipment 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.JobsCreateJobRequestBody} request * @param {BetaApIsClient.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.betaApIs.createJob({ * job: { * endDate: "2019-06-13T19:08:25Z", * id: "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", * name: "My Job Name", * startDate: "2019-06-13T19:08:25Z" * } * }) */ createJob(request: Samsara.JobsCreateJobRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createJob; /** * Deletes an existing job. * * To use this endpoint, select **Write Jobs** under the Equipment 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.DeleteJobRequest} request * @param {BetaApIsClient.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.betaApIs.deleteJob({ * id: "id" * }) */ deleteJob(request: Samsara.DeleteJobRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteJob; /** * Patches an existing job and returns it. * * To use this endpoint, select **Write Jobs** under the Equipment 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.JobsPatchJobRequestBody} request * @param {BetaApIsClient.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.betaApIs.patchJob({ * id: "id", * job: {} * }) */ patchJob(request: Samsara.JobsPatchJobRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __patchJob; /** * This endpoint will return all detections detected by in-vehicle assets and associated metadata. To get core endpoint data, select View Safety Detection Log under the Safety & Cameras category when creating or editing an API token. * * If you include an endTime, the endpoint will return data up until that point. If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. Results are paginated. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Detection Log** under the Safety & Cameras 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.GetDetectionsRequest} request * @param {BetaApIsClient.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.betaApIs.getDetections({ * startTime: "startTime" * }) */ getDetections(request: Samsara.GetDetectionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getDetections; /** * Returns all installed cameras (CM3x, AIM4, AHD1), vehicle gateways (VGs), asset gateways (AGs), and asset tags (AT11–AT13) and their health information within an organization. * * **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Devices API enabled for your organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Devices** under the Devices 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.GetDevicesRequest} request * @param {BetaApIsClient.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.betaApIs.getDevices() */ getDevices(request?: Samsara.GetDevicesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getDevices; /** * Returns every Data Sharing Agreement (DSA) your organization participates in, as either the provider or the recipient. Soft-deleted agreements are omitted. Narrow the results with the ids, statusIn, and roleIn filters, and page through large result sets with cursor pagination. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Asset Sharing** under the Asset Sharing 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.ListAssetSharingAgreementsRequest} request * @param {BetaApIsClient.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.betaApIs.listAssetSharingAgreements() */ listAssetSharingAgreements(request?: Samsara.ListAssetSharingAgreementsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listAssetSharingAgreements; /** * Creates a new Data Sharing Agreement (DSA) in pending status. Only the provider organization can create an agreement, and the recipient must be a different organization. Use providerDataPackages and recipientDataPackages to declare which categories of data flow to each side, and operator to indicate which organization operates the assets (where the gateways live). * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Asset Sharing** under the Asset Sharing 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.AssetSharingAgreementsCreateAssetSharingAgreementRequestBody} request * @param {BetaApIsClient.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.betaApIs.createAssetSharingAgreement({ * operator: "provider", * providerDataPackages: ["all", "maintenance", "maintenance", "maintenance"], * recipientDataPackages: ["all", "reefer", "all", "maintenance"], * recipientOrganizationId: "456", * recipientOrganizationName: "Acme Logistics" * }) */ createAssetSharingAgreement(request: Samsara.AssetSharingAgreementsCreateAssetSharingAgreementRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createAssetSharingAgreement; /** * Soft-deletes a Data Sharing Agreement so it no longer appears in list results. Only the provider organization can delete, and only while the agreement is in pending, rejected, or canceled status; an accepted agreement must be canceled first. Identify the agreement with the id query parameter. Returns 204 No Content. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Asset Sharing** under the Asset Sharing 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.DeleteAssetSharingAgreementRequest} request * @param {BetaApIsClient.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.betaApIs.deleteAssetSharingAgreement({ * id: "id" * }) */ deleteAssetSharingAgreement(request: Samsara.DeleteAssetSharingAgreementRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteAssetSharingAgreement; /** * Accepts a pending Data Sharing Agreement, transitioning it to accepted. Only the recipient organization can accept. Identify the agreement with the id query parameter. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Asset Sharing** under the Asset Sharing 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.AcceptAssetSharingAgreementRequest} request * @param {BetaApIsClient.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.betaApIs.acceptAssetSharingAgreement({ * id: "id" * }) */ acceptAssetSharingAgreement(request: Samsara.AcceptAssetSharingAgreementRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __acceptAssetSharingAgreement; /** * Returns shared asset records under a Data Sharing Agreement, identified by the dsaId query parameter. Results may include ended or historical sharing records; use each record's startTime and endTime to determine whether sharing is currently active. Supports cursor pagination. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Asset Sharing** under the Asset Sharing 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.ListSharedAssetsRequest} request * @param {BetaApIsClient.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.betaApIs.listSharedAssets({ * dsaId: "dsaId" * }) */ listSharedAssets(request: Samsara.ListSharedAssetsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listSharedAssets; /** * Shares one or more assets under an accepted Data Sharing Agreement, identified by the dsaId query parameter. Available only to the provider organization. Serials are matched in canonical form. Up to 100 assets may be shared per request; each may carry an optional startTime (defaults to now) and endTime (defaults to indefinite). * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Asset Sharing** under the Asset Sharing 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.AssetSharingAgreementsCreateSharedAssetsBatchRequestBody} request * @param {BetaApIsClient.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.betaApIs.createSharedAssetsBatch({ * dsaId: "dsaId", * data: [{ * serial: "GVJC3VXXXX" * }] * }) */ createSharedAssetsBatch(request: Samsara.AssetSharingAgreementsCreateSharedAssetsBatchRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createSharedAssetsBatch; /** * Updates the sharing period of one or more shared assets, each identified by its shared-asset id. Only the endTime can be changed (an empty value means indefinite sharing). To stop sharing an asset, set its endTime to the current time rather than deleting it, which preserves the rental history. Up to 100 assets may be updated per request. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Asset Sharing** under the Asset Sharing 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.AssetSharingAgreementsUpdateSharedAssetsBatchRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateSharedAssetsBatch({ * data: [{ * endTime: "2025-01-13T10:00:00Z", * id: "11111111-1111-1111-1111-111111111111" * }] * }) */ updateSharedAssetsBatch(request: Samsara.AssetSharingAgreementsUpdateSharedAssetsBatchRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateSharedAssetsBatch; /** * Cancels one or more asset sharings, each identified by its shared-asset id. Active sharings end immediately, future sharings are converted to zero-length sharings, and already-ended sharings are returned unchanged, so the request is safe to retry. Up to 100 asset sharings may be canceled per request, and the rate limit applies to this endpoint rather than to the individual asset sharings within a request. The batch may partially succeed: each asset sharing is processed independently, and callers must inspect each item's status in the response. A failure for one asset sharing does not prevent other valid asset sharings in the batch from being canceled. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Asset Sharing** under the Asset Sharing 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.AssetSharingAgreementsCancelSharedAssetsBatchRequestBody} request * @param {BetaApIsClient.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.betaApIs.cancelSharedAssetsBatch({ * data: [{ * id: "12345" * }] * }) */ cancelSharedAssetsBatch(request: Samsara.AssetSharingAgreementsCancelSharedAssetsBatchRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __cancelSharedAssetsBatch; /** * Cancels an accepted Data Sharing Agreement, transitioning it to the terminal canceled state and ending all asset sharing under it. Either the provider or the recipient can cancel. Identify the agreement with the id query parameter. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Asset Sharing** under the Asset Sharing 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.CancelAssetSharingAgreementRequest} request * @param {BetaApIsClient.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.betaApIs.cancelAssetSharingAgreement({ * id: "id" * }) */ cancelAssetSharingAgreement(request: Samsara.CancelAssetSharingAgreementRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __cancelAssetSharingAgreement; /** * Rejects a pending Data Sharing Agreement, transitioning it to the terminal rejected state. Only the recipient organization can reject. Identify the agreement with the id query parameter. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Asset Sharing** under the Asset Sharing 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.RejectAssetSharingAgreementRequest} request * @param {BetaApIsClient.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.betaApIs.rejectAssetSharingAgreement({ * id: "id" * }) */ rejectAssetSharingAgreement(request: Samsara.RejectAssetSharingAgreementRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __rejectAssetSharingAgreement; /** * List active asset assignments for the authorized organization. This endpoint only returns currently active assignments. During Beta, response ordering is implementation-defined and will stabilize before GA when database-backed pagination lands. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Assignments** under the Assignments 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.ListAssetAssignmentsRequest} request * @param {BetaApIsClient.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.betaApIs.listAssetAssignments() */ listAssetAssignments(request?: Samsara.ListAssetAssignmentsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listAssetAssignments; /** * Create an asset assignment. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Assignments** under the Assignments 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.AssetAssignmentsCreateAssetAssignmentRequestBody} request * @param {BetaApIsClient.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.betaApIs.createAssetAssignment({ * assetId: "281474978683353", * assigneeId: "494123", * assigneeType: "driver" * }) */ createAssetAssignment(request: Samsara.AssetAssignmentsCreateAssetAssignmentRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createAssetAssignment; /** * Unassign an active asset assignment. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Assignments** under the Assignments 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.AssetAssignmentsUnassignAssetAssignmentRequestBody} request * @param {BetaApIsClient.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.betaApIs.unassignAssetAssignment({ * assetId: "281474978683353" * }) */ unassignAssetAssignment(request: Samsara.AssetAssignmentsUnassignAssetAssignmentRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __unassignAssetAssignment; /** * List associations between vehicles and peripheral devices within a given time range. Associations represent the relationship between a central device (vehicle) and a peripheral device (e.g. asset tag). An association with a null endTime is still active. If no endTime query parameter is provided, all associations from startTime onward are returned, including currently active (open) associations. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Assets** under the Assets 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.ListAssociationsRequest} request * @param {BetaApIsClient.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.betaApIs.listAssociations({ * startTime: "startTime" * }) */ listAssociations(request: Samsara.ListAssociationsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listAssociations; /** * List all assets that are currently marked as missing for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Assets** under the Assets 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.ListDeviceRecoveryMissingAssetsRequest} request * @param {BetaApIsClient.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.betaApIs.listDeviceRecoveryMissingAssets() */ listDeviceRecoveryMissingAssets(request?: Samsara.ListDeviceRecoveryMissingAssetsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listDeviceRecoveryMissingAssets; /** * Mark an asset as missing. Optionally specify a note and notification recipients who will receive email updates. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Assets** under the Assets 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.DeviceRecoveryMarkAssetMissingRequestBody} request * @param {BetaApIsClient.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.betaApIs.markAssetMissing({ * id: "id" * }) */ markAssetMissing(request: Samsara.DeviceRecoveryMarkAssetMissingRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __markAssetMissing; /** * Mark a missing asset as recovered. Provide the recovery status, reason for being missing, and optional additional details. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Assets** under the Assets 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.DeviceRecoveryRecoverAssetRequestBody} request * @param {BetaApIsClient.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.betaApIs.recoverAsset({ * id: "id", * missing_reason: "MISPLACED", * recovery_status: "YES", * status: "RECOVERED" * }) */ recoverAsset(request: Samsara.DeviceRecoveryRecoverAssetRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __recoverAsset; /** * Resolves a driver by name within an organization via voice sign-in, then creates a driver-vehicle assignment via the Driver Assignment Service. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Assignments** under the Assignments 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.ResolveAssignmentByDetailsResolveAssignmentByDetailsRequestBody} request * @param {BetaApIsClient.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.betaApIs.resolveAssignmentByDetails({ * driverName: "Jane Doe", * vehicleId: "281474978683353" * }) */ resolveAssignmentByDetails(request: Samsara.ResolveAssignmentByDetailsResolveAssignmentByDetailsRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __resolveAssignmentByDetails; /** * Publish or unpublish a driver app workflow to one or more drivers by their IDs. If a workflow is published to a driver who already has it, or unpublished from a driver who does not have it, the operation is a no-op for that driver. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Driver App Settings** 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.DriverWorkflowAssignmentsPostDriverWorkflowAssignmentRequestBody} request * @param {BetaApIsClient.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.betaApIs.postDriverWorkflowAssignment({ * workflowId: "a4db8702-79d5-4396-a717-e301d52ecc11" * }) */ postDriverWorkflowAssignment(request: Samsara.DriverWorkflowAssignmentsPostDriverWorkflowAssignmentRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __postDriverWorkflowAssignment; /** * List the driver app workflows configured for the organization. Use the returned workflow IDs to reference workflows from the driver create/update APIs or from the driver workflow assignment API. Workflows are organization-scoped and unique per organization. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Drivers** 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.ListDriverWorkflowsRequest} request * @param {BetaApIsClient.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.betaApIs.listDriverWorkflows() */ listDriverWorkflows(request?: Samsara.ListDriverWorkflowsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listDriverWorkflows; /** * Set the state of a digital output on the gateway connected to a piece of powered equipment. The command is delivered to the device synchronously; a success response indicates the device acknowledged and applied the requested state. This requires an AG53 gateway connected to powered equipment via the CBL-AG-BEQP cable. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Equipment Output Control** under the Closed Beta 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.EquipmentOutputControlSetEquipmentDigitalOutputRequestBody} request * @param {BetaApIsClient.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.betaApIs.setEquipmentDigitalOutput({ * id: 1000000, * pinId: 1, * state: true * }) */ setEquipmentDigitalOutput(request: Samsara.EquipmentOutputControlSetEquipmentDigitalOutputRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __setEquipmentDigitalOutput; /** * Returns fleet installer photo upload sessions for the caller's org. Results are ordered by updatedAtTime ascending and paginated (up to 25 per page). Supports filtering by session IDs, startTime, and endTime. Omitting startTime returns all sessions for the org. endTime requires startTime. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Devices** under the Devices 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.GetFleetInstallerPhotoUploadsRequest} request * @param {BetaApIsClient.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.betaApIs.getFleetInstallerPhotoUploads() */ getFleetInstallerPhotoUploads(request?: Samsara.GetFleetInstallerPhotoUploadsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getFleetInstallerPhotoUploads; /** * Creates a fleet installer photo upload session and returns a presigned S3 PUT URL. Upload the file bytes directly to the presigned URL using the headers in uploadContext, then call POST /fleet/installer/photo-uploads/complete to finalize. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Devices** under the Devices 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.FleetInstallerPhotoUploadsPostFleetInstallerPhotoUploadRequestBody} request * @param {BetaApIsClient.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.betaApIs.postFleetInstallerPhotoUpload({ * contentMd5: "rL0Y20zC+Fzt72VPzMSk2A==", * deviceId: "281474977961335", * fileFormatType: "imageJpeg", * fileName: "front_camera_install.jpg", * hardwareType: "vehicleGateway", * photoType: "installPhoto", * sizeBytes: 482193 * }) */ postFleetInstallerPhotoUpload(request: Samsara.FleetInstallerPhotoUploadsPostFleetInstallerPhotoUploadRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __postFleetInstallerPhotoUpload; /** * Marks a fleet installer photo upload session as complete after the file bytes have been uploaded to S3. Triggers async processing of the photo. Poll GET /fleet/installer/photo-uploads to observe the final state. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Devices** under the Devices 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.PostFleetInstallerPhotoUploadCompleteRequest} request * @param {BetaApIsClient.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.betaApIs.postFleetInstallerPhotoUploadComplete({ * id: "id" * }) */ postFleetInstallerPhotoUploadComplete(request: Samsara.PostFleetInstallerPhotoUploadCompleteRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __postFleetInstallerPhotoUploadComplete; /** * Returns the list of vendor categories available for maintenance vendors. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Work Orders** under the Work Orders 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.ListVendorCategoriesRequest} request * @param {BetaApIsClient.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.betaApIs.listVendorCategories() */ listVendorCategories(request?: Samsara.ListVendorCategoriesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listVendorCategories; /** * Returns a paginated list of maintenance vendors in the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Work Orders** under the Work Orders 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.ListMaintenanceVendorsRequest} request * @param {BetaApIsClient.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.betaApIs.listMaintenanceVendors() */ listMaintenanceVendors(request?: Samsara.ListMaintenanceVendorsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listMaintenanceVendors; /** * Returns the latest live tachograph data for drivers, including working state and driving rest times, sourced from real-time telemetry. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Tachograph (EU)** under the Compliance category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.ListTachographLiveDataRequest} request * @param {BetaApIsClient.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.betaApIs.listTachographLiveData() */ listTachographLiveData(request?: Samsara.ListTachographLiveDataRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listTachographLiveData; /** * Reserve a tachograph file upload and return a presigned URL. Upload the file bytes directly to the URL with the returned headers. The driver or device the file belongs to is resolved from the file contents after upload. * * **Uploading the file** * * Once you have the `uploadUrl` and `requiredHeaders` from the response, PUT the raw file bytes directly to the URL — do not send the request through the Samsara API servers: * * ```bash * curl -X PUT "" \ * -H "Content-Type: " \ * -H "Content-MD5: " \ * -H "Content-Length: " \ * --data-binary @/path/to/file.ddd * ``` * * Every header listed in `requiredHeaders` must be sent verbatim — they are part of the URL signature, and the upload is rejected with a `403` if any header is missing or has a different value. * * **Retrieving uploaded files** * * A successful response to this request reserves the upload; it does not indicate that a file has been received or processed. Uploaded files are processed asynchronously after the PUT completes. Once a file has been processed, it can be retrieved through the standard tachograph file endpoints: * * - **Driver-card files** — `GET /fleet/drivers/tachograph-files/history` * - **Vehicle-unit files** — `GET /fleet/vehicles/tachograph-files/history` * * Files that cannot be processed — for example files that are corrupt, are not valid tachograph files, or cannot be matched to a driver or vehicle in your organization — are not retrievable through these endpoints. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Tachograph (EU)** under the Compliance category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.TachographFileUploadsPostTachographFileUploadRequestBody} request * @param {BetaApIsClient.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.betaApIs.postTachographFileUpload({ * contentMd5: "rL0Y20zC+Fzt72VPzMSk2A==", * contentType: "application/octet-stream", * fileSizeBytes: 8192, * fileType: "driverCard" * }) */ postTachographFileUpload(request: Samsara.TachographFileUploadsPostTachographFileUploadRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __postTachographFileUpload; /** * Get the engine immobilizer states of the queried vehicles. If a vehicle has never had an engine immobilizer connected, there won't be any state returned for that vehicle. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Vehicle Immobilization** under the Vehicles 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.GetEngineImmobilizerStatesRequest} request * @param {BetaApIsClient.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.betaApIs.getEngineImmobilizerStates({ * vehicleIds: "vehicleIds", * startTime: "startTime" * }) */ getEngineImmobilizerStates(request: Samsara.GetEngineImmobilizerStatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getEngineImmobilizerStates; /** * Create a new Function with the given name, description, and configuration. The response includes a URL (`uploadPutUrl`) for uploading the function's code package. After uploading, call `POST /functions/{name}/deploy` to make the function runnable. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Functions** under the Functions 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.FunctionsCreateFunctionRequestBody} request * @param {BetaApIsClient.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.betaApIs.createFunction({ * config: { * handler: "index.handler" * }, * name: "my-function" * }) */ createFunction(request: Samsara.FunctionsCreateFunctionRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createFunction; /** * Get a file from Functions storage by name. Returns file metadata and a presigned download URL. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Functions Storage** under the Functions 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.GetFunctionStorageFileRequest} request * @param {BetaApIsClient.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.betaApIs.getFunctionStorageFile({ * name: "name" * }) */ getFunctionStorageFile(request: Samsara.GetFunctionStorageFileRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getFunctionStorageFile; /** * Create a new file in Functions storage. Returns a presigned upload URL. Returns an error if the file already exists. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Functions Storage** under the Functions 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.FunctionsStorageCreateFunctionStorageFileRequestBody} request * @param {BetaApIsClient.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.betaApIs.createFunctionStorageFile({ * name: "my-script.js" * }) */ createFunctionStorageFile(request: Samsara.FunctionsStorageCreateFunctionStorageFileRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createFunctionStorageFile; /** * Get a presigned upload URL for overwriting an existing file in Functions storage. Returns an error if the file does not exist. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Functions Storage** under the Functions 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.UpdateFunctionStorageFileRequest} request * @param {BetaApIsClient.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.betaApIs.updateFunctionStorageFile({ * name: "name" * }) */ updateFunctionStorageFile(request: Samsara.UpdateFunctionStorageFileRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateFunctionStorageFile; /** * Delete a file from Functions storage by name. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Functions Storage** under the Functions 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.DeleteFunctionStorageFileRequest} request * @param {BetaApIsClient.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.betaApIs.deleteFunctionStorageFile({ * name: "name" * }) */ deleteFunctionStorageFile(request: Samsara.DeleteFunctionStorageFileRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteFunctionStorageFile; /** * List files in Functions storage for the organization. Returns file metadata and optionally includes presigned download or upload URLs. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Functions Storage** under the Functions 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.ListFunctionsStorageFilesRequest} request * @param {BetaApIsClient.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.betaApIs.listFunctionsStorageFiles() */ listFunctionsStorageFiles(request?: Samsara.ListFunctionsStorageFilesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listFunctionsStorageFiles; /** * Retrieve the current state of an existing Function, including its configuration, code package status, and a `lastUpdateTimestampMs` value for use in subsequent PATCH requests. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Functions** under the Functions 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.GetFunctionRequest} request * @param {BetaApIsClient.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.betaApIs.getFunction({ * name: "name" * }) */ getFunction(request: Samsara.GetFunctionRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getFunction; /** * Delete a Function by name. A Function that is currently configured as an action in a workflow config cannot be deleted. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Functions** under the Functions 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.DeleteFunctionRequest} request * @param {BetaApIsClient.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.betaApIs.deleteFunction({ * name: "name" * }) */ deleteFunction(request: Samsara.DeleteFunctionRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteFunction; /** * Update an existing Function's description and configuration. The request must include `lastUpdateTimestampMs`, which is the timestamp value obtained from a previous create or get response. The response includes a URL (`uploadPutUrl`) for uploading new code. After uploading, call `POST /functions/{name}/deploy` for the changes to be applied. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Functions** under the Functions 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.FunctionsPatchFunctionRequestBody} request * @param {BetaApIsClient.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.betaApIs.patchFunction({ * name: "name", * lastUpdateTimestampMs: 1609459200000 * }) */ patchFunction(request: Samsara.FunctionsPatchFunctionRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __patchFunction; /** * Deploy the uploaded code package for the specified Function, making it runnable. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Functions** under the Functions 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.DeployFunctionRequest} request * @param {BetaApIsClient.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.betaApIs.deployFunction({ * name: "name" * }) */ deployFunction(request: Samsara.DeployFunctionRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deployFunction; /** * Retrieve paginated log entries for a specific Function within a given time range. Logs are produced during Function executions and can be filtered by text content. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Functions** under the Functions 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.GetFunctionLogsRequest} request * @param {BetaApIsClient.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.betaApIs.getFunctionLogs({ * name: "name", * startTime: "2024-01-15T09:30:00Z", * endTime: "2024-01-15T09:30:00Z" * }) */ getFunctionLogs(request: Samsara.GetFunctionLogsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getFunctionLogs; /** * Start an asynchronous run for the specified Function. This endpoint allows you to override parameters available at runtime. * * Rate limit: 2 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Functions** under the Functions 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.FunctionsStartFunctionRunRequestBody} request * @param {BetaApIsClient.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.betaApIs.startFunctionRun({ * name: "name", * paramsOverride: {} * }) */ startFunctionRun(request: Samsara.FunctionsStartFunctionRunRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __startFunctionRun; /** * Retrieve the execution summary for a specific Function run, identified by the correlationId returned from the start run endpoint. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Functions** under the Functions 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.GetFunctionRunRequest} request * @param {BetaApIsClient.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.betaApIs.getFunctionRun({ * name: "name", * correlationId: "correlationId" * }) */ getFunctionRun(request: Samsara.GetFunctionRunRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getFunctionRun; /** * Reassign one or more gateways to different devices in a single call. Mirrors the dashboard's "Pair Gateway" flow and accepts up to 50 gateway-device pairs per request. Works for any device type: vehicles, assets, equipment, trailers, industrial machines, and asset tags. By default, devices that the reassigned gateways were previously linked to remain in their current group. Pass `removeOrphanDevices: true` to move those orphaned devices to the unassigned group and clear their tags. The endpoint is currently in Beta and gated behind a feature configuration; contact your Samsara representative to enable access. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Gateways** under the Setup & Administration 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.GatewaysPairGatewaysRequestBody} request * @param {BetaApIsClient.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.betaApIs.pairGateways({ * pairs: [{ * deviceSerial: "GFRV-43N-VGX", * gatewaySerial: "GFRV-43N-VGX" * }] * }) */ pairGateways(request: Samsara.GatewaysPairGatewaysRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __pairGateways; /** * Returns a paginated list of Ground Intelligence issues for an organization, ordered by updatedAtTime descending and then id ascending. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Ground Intelligence Issues** under the Ground Intelligence 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.ListIssuesRequest} request * @param {BetaApIsClient.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.betaApIs.listIssues() */ listIssues(request?: Samsara.ListIssuesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listIssues; /** * Updates the status, type, or dismissal metadata for a Ground Intelligence road-condition issue. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Ground Intelligence Issues** under the Ground Intelligence 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.EntityGroundIntelligenceIssuesServiceUpdateGroundIntelligenceIssueRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateGroundIntelligenceIssue({ * id: "id" * }) */ updateGroundIntelligenceIssue(request: Samsara.EntityGroundIntelligenceIssuesServiceUpdateGroundIntelligenceIssueRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateGroundIntelligenceIssue; /** * Creates a Ground Intelligence watchpoint for the organization. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Watchpoints** under the Ground Intelligence 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.EntityWatchpointsServiceCreateWatchpointRequestBody} request * @param {BetaApIsClient.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.betaApIs.createWatchpoint({ * location: { * latitude: 37.7749, * longitude: -122.4194 * }, * mode: "justOnce", * observationType: "roadDefect" * }) */ createWatchpoint(request: Samsara.EntityWatchpointsServiceCreateWatchpointRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createWatchpoint; /** * Updates the name, note, or observation type for an existing Ground Intelligence watchpoint. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Watchpoints** under the Ground Intelligence 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.EntityWatchpointsServiceUpdateWatchpointRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateWatchpoint({ * id: "id" * }) */ updateWatchpoint(request: Samsara.EntityWatchpointsServiceUpdateWatchpointRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateWatchpoint; /** * Update the shippingDocs field of an existing assignment. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write ELD Hours of Service (US)** under the Compliance category when creating or editing an API token. Learn More. * * * **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. * * @param {Samsara.HosDailyLogsUpdateShippingDocsRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateShippingDocs({ * hosDate: "hosDate", * driverID: "driverID", * shippingDocs: "ShippingID1, ShippingID2" * }) */ updateShippingDocs(request: Samsara.HosDailyLogsUpdateShippingDocsRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateShippingDocs; /** * Retrieve all orders for a specific plan, including both assigned and unassigned orders. * * **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have RoutePlanning APIs enabled for your organization. * * Rate limit: 10 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. * * * **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.ListPlanOrdersRequest} request * @param {BetaApIsClient.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.betaApIs.listPlanOrders({ * planId: "planId" * }) */ listPlanOrders(request: Samsara.ListPlanOrdersRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listPlanOrders; /** * Delete one or more orders from a plan. Pass either `orderIds` (a comma-separated list) or `deleteAll=true`; exactly one is required. Orders are automatically unassigned from their routes before deletion. * * **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have RoutePlanning APIs enabled for your organization. * * Rate limit: 5 requests/sec (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. * * * **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.DeletePlanOrdersRequest} request * @param {BetaApIsClient.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.betaApIs.deletePlanOrders({ * planId: "planId" * }) */ deletePlanOrders(request: Samsara.DeletePlanOrdersRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deletePlanOrders; /** * Retrieve route templates for a specific hub. Optionally filter by route template ID or name. * * Rate limit: 10 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. * * * **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.ListHubRouteTemplatesRequest} request * @param {BetaApIsClient.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.betaApIs.listHubRouteTemplates({ * hubId: "hubId" * }) */ listHubRouteTemplates(request: Samsara.ListHubRouteTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listHubRouteTemplates; /** * Create a new route template for a hub. * * Rate limit: 5 requests/sec (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. * * * **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.HubRouteTemplatesCreateHubRouteTemplateRequestBody} request * @param {BetaApIsClient.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.betaApIs.createHubRouteTemplate({ * hubId: "550e8400-e29b-41d4-a716-446655440000", * name: "Downtown Delivery Route" * }) */ createHubRouteTemplate(request: Samsara.HubRouteTemplatesCreateHubRouteTemplateRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createHubRouteTemplate; /** * Delete a route template by its unique identifier. * * Rate limit: 5 requests/sec (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. * * * **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.DeleteHubRouteTemplateRequest} request * @param {BetaApIsClient.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.betaApIs.deleteHubRouteTemplate({ * id: "id" * }) */ deleteHubRouteTemplate(request: Samsara.DeleteHubRouteTemplateRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteHubRouteTemplate; /** * Update an existing route template by its unique identifier. Only the fields provided in the request body are changed. * * Rate limit: 5 requests/sec (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. * * * **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.HubRouteTemplatesUpdateHubRouteTemplateRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateHubRouteTemplate({ * id: "id" * }) */ updateHubRouteTemplate(request: Samsara.HubRouteTemplatesUpdateHubRouteTemplateRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateHubRouteTemplate; /** * Returns a paginated list of parts for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Parts** under the Work Orders 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.ListPartsRequest} request * @param {BetaApIsClient.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.betaApIs.listParts() */ listParts(request?: Samsara.ListPartsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listParts; /** * Creates a part for the organization. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Parts** under the Work Orders 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.EntityPartDefinitionsServiceCreatePartRequestBody} request * @param {BetaApIsClient.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.betaApIs.createPart({ * partNumber: "12345" * }) */ createPart(request: Samsara.EntityPartDefinitionsServiceCreatePartRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createPart; /** * Deletes a part for the organization. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Parts** under the Work Orders 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.DeletePartRequest} request * @param {BetaApIsClient.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.betaApIs.deletePart({ * id: "id" * }) */ deletePart(request: Samsara.DeletePartRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deletePart; /** * Updates an existing part for the organization. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Parts** under the Work Orders 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.EntityPartDefinitionsServiceUpdatePartRequestBody} request * @param {BetaApIsClient.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.betaApIs.updatePart({ * id: "id" * }) */ updatePart(request: Samsara.EntityPartDefinitionsServiceUpdatePartRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updatePart; /** * Returns a paginated list of per-part, per-location inventory levels for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Parts** under the Work Orders 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.ListPartInventoryRequest} request * @param {BetaApIsClient.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.betaApIs.listPartInventory() */ listPartInventory(request?: Samsara.ListPartInventoryRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listPartInventory; /** * Creates per-part, per-location inventory metadata for the organization. Upserts by part and place — a second create at the same pair updates the existing record instead of duplicating it. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Parts** under the Work Orders 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.EntityPartInventoryLocationsServiceCreatePartInventoryLocationRequestBody} request * @param {BetaApIsClient.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.betaApIs.createPartInventoryLocation() */ createPartInventoryLocation(request?: Samsara.EntityPartInventoryLocationsServiceCreatePartInventoryLocationRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createPartInventoryLocation; /** * Updates existing per-part, per-location inventory metadata for the organization. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Parts** under the Work Orders 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.EntityPartInventoryLocationsServiceUpdatePartInventoryLocationRequestBody} request * @param {BetaApIsClient.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.betaApIs.updatePartInventoryLocation() */ updatePartInventoryLocation(request?: Samsara.EntityPartInventoryLocationsServiceUpdatePartInventoryLocationRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updatePartInventoryLocation; /** * Records a receive, transfer, scrap, or adjust stock movement against a part's inventory and returns the resulting inventory location(s). Not idempotent — retrying a request that already succeeded records the movement again. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Parts** under the Work Orders 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.CreateStockMovementActionServiceCreateStockMovementRequestBody} request * @param {BetaApIsClient.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.betaApIs.createStockMovement({ * movementType: "12345", * partSamsaraId: "12345", * quantity: 123.45 * }) */ createStockMovement(request: Samsara.CreateStockMovementActionServiceCreateStockMovementRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createStockMovement; /** * Returns a paginated, time-windowed feed of inventory transactions (an append-only parts audit log) for the organization, ordered by the time each transaction occurred. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Parts** under the Work Orders 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.ListPartTransactionsRequest} request * @param {BetaApIsClient.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.betaApIs.listPartTransactions({ * happenedAtTimeStart: "happenedAtTimeStart" * }) */ listPartTransactions(request: Samsara.ListPartTransactionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listPartTransactions; /** * Resolves the current open preventive maintenance instance for a schedule and asset, and automatically creates the next due record based on the schedule's intervals. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Preventive Maintenance Resolve** under the Preventive Maintenance 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.ResolvePreventiveMaintenanceActionServiceResolvePreventiveMaintenanceRequestBody} request * @param {BetaApIsClient.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.betaApIs.resolvePreventiveMaintenance() */ resolvePreventiveMaintenance(request?: Samsara.ResolvePreventiveMaintenanceActionServiceResolvePreventiveMaintenanceRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __resolvePreventiveMaintenance; /** * Returns a paginated list of preventive maintenance schedules for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Preventive Maintenance Schedules** under the Preventive Maintenance 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.ListPreventiveMaintenanceSchedulesRequest} request * @param {BetaApIsClient.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.betaApIs.listPreventiveMaintenanceSchedules() */ listPreventiveMaintenanceSchedules(request?: Samsara.ListPreventiveMaintenanceSchedulesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listPreventiveMaintenanceSchedules; /** * Returns a paginated list of upcoming preventive maintenance schedules for the organization's assets, enriched with live telemetry (current odometer, engine hours) and due-date projections. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Upcoming Preventive Maintenance** under the Preventive Maintenance 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.ListUpcomingPreventiveMaintenanceRequest} request * @param {BetaApIsClient.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.betaApIs.listUpcomingPreventiveMaintenance() */ listUpcomingPreventiveMaintenance(request?: Samsara.ListUpcomingPreventiveMaintenanceRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listUpcomingPreventiveMaintenance; /** * Patches the due-target and last-resolved values on the open preventive maintenance instance for a schedule and asset. Only fields provided in the request are updated. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Upcoming Preventive Maintenance** under the Preventive Maintenance 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.EntityUpcomingPreventativeMaintenancesServiceUpdateUpcomingPreventiveMaintenanceRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateUpcomingPreventiveMaintenance() */ updateUpcomingPreventiveMaintenance(request?: Samsara.EntityUpcomingPreventativeMaintenancesServiceUpdateUpcomingPreventiveMaintenanceRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateUpcomingPreventiveMaintenance; /** * Returns a paginated list of purchase orders ordered by last update time. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Purchase Orders** under the Work Orders 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.ListPurchaseOrdersRequest} request * @param {BetaApIsClient.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.betaApIs.listPurchaseOrders({ * ids: "281474976710656", * poNumbers: "PO-1001", * vendorIds: "281474976710656", * endTime: "2026-07-31T00:00:00Z", * startTime: "2026-07-01T00:00:00Z" * }) */ listPurchaseOrders(request: Samsara.ListPurchaseOrdersRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listPurchaseOrders; /** * Creates a purchase order for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Purchase Orders** under the Work Orders 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.EntityPurchaseOrdersServiceCreatePurchaseOrderRequestBody} request * @param {BetaApIsClient.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.betaApIs.createPurchaseOrder({ * orderStatus: "Unknown", * vendorId: "281474976710656" * }) */ createPurchaseOrder(request: Samsara.EntityPurchaseOrdersServiceCreatePurchaseOrderRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createPurchaseOrder; /** * Deletes a purchase order for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Purchase Orders** under the Work Orders 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.DeletePurchaseOrderRequest} request * @param {BetaApIsClient.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.betaApIs.deletePurchaseOrder({ * id: "id" * }) */ deletePurchaseOrder(request: Samsara.DeletePurchaseOrderRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deletePurchaseOrder; /** * Updates a purchase order for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Purchase Orders** under the Work Orders 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.EntityPurchaseOrdersServiceUpdatePurchaseOrderRequestBody} request * @param {BetaApIsClient.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.betaApIs.updatePurchaseOrder({ * id: "id" * }) */ updatePurchaseOrder(request: Samsara.EntityPurchaseOrdersServiceUpdatePurchaseOrderRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updatePurchaseOrder; /** * Returns a paginated list of maintenance sites for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Maintenance Sites** under the Work Orders 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.ListMaintenanceSitesRequest} request * @param {BetaApIsClient.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.betaApIs.listMaintenanceSites() */ listMaintenanceSites(request?: Samsara.ListMaintenanceSitesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listMaintenanceSites; /** * Creates a maintenance site for the organization. Exactly one of placeIds or customAddress must be set. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Maintenance Sites** under the Work Orders 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.EntityMaintenanceSitesServiceCreateMaintenanceSiteRequestBody} request * @param {BetaApIsClient.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.betaApIs.createMaintenanceSite({ * name: "12345", * siteCode: "12345", * siteType: "Unknown" * }) */ createMaintenanceSite(request: Samsara.EntityMaintenanceSitesServiceCreateMaintenanceSiteRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createMaintenanceSite; /** * Updates an existing maintenance site for the organization. Moving a site between placeIds and customAddress is not supported. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Maintenance Sites** under the Work Orders 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.EntityMaintenanceSitesServiceUpdateMaintenanceSiteRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateMaintenanceSite({ * id: "id" * }) */ updateMaintenanceSite(request: Samsara.EntityMaintenanceSitesServiceUpdateMaintenanceSiteRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateMaintenanceSite; /** * Returns a paginated feed of technician time entries updated in the requested time window, including deletion tombstones. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Time Entries** under the Work Orders 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.ListTimeEntriesRequest} request * @param {BetaApIsClient.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.betaApIs.listTimeEntries({ * startTime: "startTime" * }) */ listTimeEntries(request: Samsara.ListTimeEntriesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listTimeEntries; /** * Returns a paginated list of warranties for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Warranties** under the Work Orders 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.ListWarrantiesRequest} request * @param {BetaApIsClient.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.betaApIs.listWarranties() */ listWarranties(request?: Samsara.ListWarrantiesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listWarranties; /** * Creates a warranty for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Warranties** under the Work Orders 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.EntityWarrantiesServiceCreateWarrantyRequestBody} request * @param {BetaApIsClient.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.betaApIs.createWarranty({ * name: "12345" * }) */ createWarranty(request: Samsara.EntityWarrantiesServiceCreateWarrantyRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createWarranty; /** * Deletes a warranty for the organization. Asset associations are removed server-side. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Warranties** under the Work Orders 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.DeleteWarrantyRequest} request * @param {BetaApIsClient.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.betaApIs.deleteWarranty({ * id: "id" * }) */ deleteWarranty(request: Samsara.DeleteWarrantyRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteWarranty; /** * Updates an existing warranty for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Warranties** under the Work Orders 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.EntityWarrantiesServiceUpdateWarrantyRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateWarranty({ * id: "id" * }) */ updateWarranty(request: Samsara.EntityWarrantiesServiceUpdateWarrantyRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateWarranty; /** * Returns the assets assigned to a warranty. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Warranties** under the Work Orders 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.ListWarrantyAssetAssignmentsRequest} request * @param {BetaApIsClient.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.betaApIs.listWarrantyAssetAssignments({ * warrantyId: "warrantyId" * }) */ listWarrantyAssetAssignments(request: Samsara.ListWarrantyAssetAssignmentsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listWarrantyAssetAssignments; /** * Replaces the full set of assets assigned to a warranty. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Warranties** under the Work Orders 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.ReplaceWarrantyAssetAssignmentsActionServiceReplaceWarrantyAssetAssignmentsRequestBody} request * @param {BetaApIsClient.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.betaApIs.replaceWarrantyAssetAssignments() */ replaceWarrantyAssetAssignments(request?: Samsara.ReplaceWarrantyAssetAssignmentsActionServiceReplaceWarrantyAssetAssignmentsRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __replaceWarrantyAssetAssignments; /** * Returns a paginated list of warranty claims for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Warranties** under the Work Orders 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.ListWarrantyClaimsRequest} request * @param {BetaApIsClient.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.betaApIs.listWarrantyClaims() */ listWarrantyClaims(request?: Samsara.ListWarrantyClaimsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listWarrantyClaims; /** * Creates a warranty claim for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Warranties** under the Work Orders 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.EntityWarrantyClaimsServiceCreateWarrantyClaimRequestBody} request * @param {BetaApIsClient.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.betaApIs.createWarrantyClaim({ * assetId: "281474976710656" * }) */ createWarrantyClaim(request: Samsara.EntityWarrantyClaimsServiceCreateWarrantyClaimRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createWarrantyClaim; /** * Deletes a warranty claim for the organization. Component links are removed server-side. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Warranties** under the Work Orders 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.DeleteWarrantyClaimRequest} request * @param {BetaApIsClient.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.betaApIs.deleteWarrantyClaim({ * id: "id" * }) */ deleteWarrantyClaim(request: Samsara.DeleteWarrantyClaimRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteWarrantyClaim; /** * Updates an existing warranty claim for the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Warranties** under the Work Orders 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.EntityWarrantyClaimsServiceUpdateWarrantyClaimRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateWarrantyClaim({ * id: "id" * }) */ updateWarrantyClaim(request: Samsara.EntityWarrantyClaimsServiceUpdateWarrantyClaimRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateWarrantyClaim; /** * Gets work order templates. Optionally filter to specific template ids; ids that do not resolve to a template (e.g. deleted) are omitted from the response. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Work Orders** under the Work Orders 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.GetWorkOrderTemplatesRequest} request * @param {BetaApIsClient.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.betaApIs.getWorkOrderTemplates() */ getWorkOrderTemplates(request?: Samsara.GetWorkOrderTemplatesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getWorkOrderTemplates; /** * Returns places for the authorized organization. Supports cursor pagination or batch fetch by Samsara place ids via `placeIds` or by external ids via `externalIds` (mutually exclusive). * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Places** under the Places 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.GetPlacesRequest} request * @param {BetaApIsClient.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.betaApIs.getPlaces() */ getPlaces(request?: Samsara.GetPlacesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getPlaces; /** * Creates a place. Supply a polygon `geofence`, a circle `geofence`, or an `auto` geofence that resolves geometry server-side. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Places** under the Places 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.PlacesPostPlaceRequestBody} request * @param {BetaApIsClient.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.betaApIs.postPlace({ * address: "123 Main St, Oakland, CA", * geofence: {}, * name: "Oakland Yard" * }) */ postPlace(request: Samsara.PlacesPostPlaceRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __postPlace; /** * Deletes a place. Pass `placeId` (Samsara id) as a query parameter. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Places** under the Places 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.DeletePlaceRequest} request * @param {BetaApIsClient.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.betaApIs.deletePlace({ * placeId: 1000000 * }) */ deletePlace(request: Samsara.DeletePlaceRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deletePlace; /** * Updates a place. Provide exactly one of query parameter `placeId` (Samsara id) or `externalId` (key:value). Only fields present in the JSON body are changed; omit a field to leave it unchanged. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Places** under the Places 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.PlacesPatchPlaceRequestBody} request * @param {BetaApIsClient.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.betaApIs.patchPlace() */ patchPlace(request?: Samsara.PlacesPatchPlaceRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __patchPlace; /** * Returns cursor-paginated deletion markers for soft-deleted places in the organization. Use for replication after DELETE /places. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Places** under the Places 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.GetPlaceDeletionsRequest} request * @param {BetaApIsClient.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.betaApIs.getPlaceDeletions() */ getPlaceDeletions(request?: Samsara.GetPlaceDeletionsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getPlaceDeletions; /** * Forward-geocodes a free-form address string. Does not create or update a Place. Returns geocode candidates with cursor pagination. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Places** under the Places 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.GetPlaceGeocodeRequest} request * @param {BetaApIsClient.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.betaApIs.getPlaceGeocode({ * address: "address" * }) */ getPlaceGeocode(request: Samsara.GetPlaceGeocodeRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getPlaceGeocode; /** * Returns geofence suggestion candidates for a seed point. Does not create or update a Place. Applies the same selection rules as geofence.auto on Place write. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Places** under the Places 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.GetPlaceGeofenceRequest} request * @param {BetaApIsClient.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.betaApIs.getPlaceGeofence({ * latitude: 1.1, * longitude: 1.1 * }) */ getPlaceGeofence(request: Samsara.GetPlaceGeofenceRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getPlaceGeofence; /** * List all preferred fuel stations for your organization. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Fuel Purchase** under the Fuel & Energy 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.ListPreferredStationsRequest} request * @param {BetaApIsClient.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.betaApIs.listPreferredStations() */ listPreferredStations(request?: Samsara.ListPreferredStationsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listPreferredStations; /** * Create a preferred fuel station for your organization. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Fuel Purchase** under the Fuel & Energy 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.PreferredStationsPostPreferredStationRequestBody} request * @param {BetaApIsClient.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.betaApIs.postPreferredStation({ * address: { * city: "Green River", * country: "US", * line1: "8901 US Hwy 374", * postalCode: "82935" * }, * externalIds: { * "key": "value" * }, * name: "Station #432" * }) */ postPreferredStation(request: Samsara.PreferredStationsPostPreferredStationRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __postPreferredStation; /** * Delete a preferred fuel station for your organization. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Fuel Purchase** under the Fuel & Energy 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.DeletePreferredStationRequest} request * @param {BetaApIsClient.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.betaApIs.deletePreferredStation({ * id: "id" * }) */ deletePreferredStation(request: Samsara.DeletePreferredStationRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deletePreferredStation; /** * Update a preferred fuel station for your organization. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Fuel Purchase** under the Fuel & Energy 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.PreferredStationsPatchPreferredStationRequestBody} request * @param {BetaApIsClient.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.betaApIs.patchPreferredStation({ * id: "id" * }) */ patchPreferredStation(request: Samsara.PreferredStationsPatchPreferredStationRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __patchPreferredStation; /** * Get a single preferred fuel station by ID. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Read Fuel Purchase** under the Fuel & Energy 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.GetPreferredStationRequest} request * @param {BetaApIsClient.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.betaApIs.getPreferredStation({ * id: "id" * }) */ getPreferredStation(request: Samsara.GetPreferredStationRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getPreferredStation; /** * Returns qualification records for the specified list of IDs. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Qualification Records** under the Qualification Records 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.GetQualificationRecordsRequest} request * @param {BetaApIsClient.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.betaApIs.getQualificationRecords() */ getQualificationRecords(request?: Samsara.GetQualificationRecordsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getQualificationRecords; /** * Creates a new qualification record. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Qualification Records** under the Qualification Records 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.QualificationsPostQualificationRecordRequestBody} request * @param {BetaApIsClient.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.betaApIs.postQualificationRecord({ * fields: [{ * id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", * type: "number" * }], * issueDate: "2025-08-27T10:20:30Z", * owner: { * entityType: "worker", * id: "281474" * }, * qualificationType: { * id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7" * } * }) */ postQualificationRecord(request: Samsara.QualificationsPostQualificationRecordRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __postQualificationRecord; /** * Deletes an existing qualification record. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Qualification Records** under the Qualification Records 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.QualificationsDeleteQualificationRecordRequestBody} request * @param {BetaApIsClient.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.betaApIs.deleteQualificationRecord({ * id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7" * }) */ deleteQualificationRecord(request: Samsara.QualificationsDeleteQualificationRecordRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteQualificationRecord; /** * Updates an existing qualification record. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Qualification Records** under the Qualification Records 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.QualificationsPatchQualificationRecordRequestBody} request * @param {BetaApIsClient.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.betaApIs.patchQualificationRecord({ * id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", * issueDate: "2025-08-27T10:20:30Z", * owner: { * entityType: "worker", * id: "281474" * } * }) */ patchQualificationRecord(request: Samsara.QualificationsPatchQualificationRecordRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __patchQualificationRecord; /** * Archives an existing qualification record. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Qualification Records** under the Qualification Records 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.QualificationsArchiveQualificationRecordRequestBody} request * @param {BetaApIsClient.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.betaApIs.archiveQualificationRecord({ * id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7" * }) */ archiveQualificationRecord(request: Samsara.QualificationsArchiveQualificationRecordRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __archiveQualificationRecord; /** * Returns all qualification records that have been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you don't include an endTime, the API will continue to poll with the pagination cursor that gets returned on every call. The hasNextPage response value will be true if there is no endTime specified and endCursor is nonempty. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Qualification Records** under the Qualification Records 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.GetQualificationRecordsStreamRequest} request * @param {BetaApIsClient.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.betaApIs.getQualificationRecordsStream({ * entityType: "worker", * startTime: "2024-01-15T09:30:00Z" * }) */ getQualificationRecordsStream(request: Samsara.GetQualificationRecordsStreamRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getQualificationRecordsStream; /** * Unarchives an existing qualification record. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Qualification Records** under the Qualification Records 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.QualificationsUnarchiveQualificationRecordRequestBody} request * @param {BetaApIsClient.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.betaApIs.unarchiveQualificationRecord({ * id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7" * }) */ unarchiveQualificationRecord(request: Samsara.QualificationsUnarchiveQualificationRecordRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __unarchiveQualificationRecord; /** * Returns a list of qualification types for the specified list of IDs. If no IDs are provided, all qualification types will be returned. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Qualification Records** under the Qualification Records 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.GetQualificationTypesRequest} request * @param {BetaApIsClient.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.betaApIs.getQualificationTypes({ * entityType: "worker" * }) */ getQualificationTypes(request: Samsara.GetQualificationTypesRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getQualificationTypes; /** * Ingest new readings. This endpoint allows the ingestion of batches of readings. * * Ingesting readings is only supported for assets created using the POST /assets API endpoint with readingsIngestionEnabled set to true. To see a full list of readings available for ingestion use the GET readings definitions API. * * * Readings that currently support ingestion (by category): * * *
* ingestible * * * `batteryVoltage` * * `coolantTemp` * * `ecuFuelLevelMillipercent` * * `engineHours` * * `engineRpm` * * `engineState` (values: off | running | idling) * * `faultCodes` * * `fuelLevelPerc` * * `gps` * * `odometerEcu` * * `oilPressure` * *
* * When ingesting GPS location data, use the readingID 'gps'. The value object must contain the following fields: 'latitude' (decimal degrees), 'longitude' (decimal degrees), and 'speed' (meters per second). * * Related guide: [Readings](https://developers.samsara.com/docs/readings). * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Readings** under the Readings 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.ReadingsPostReadingsRequestBody} request * @param {BetaApIsClient.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.betaApIs.postReadings({ * data: [{ * entityType: "asset", * happenedAtTime: "2023-10-27T10:00:00Z", * readingId: "airInletPressure", * value: { * "key": "value" * } * }] * }) */ postReadings(request: Samsara.ReadingsPostReadingsRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __postReadings; /** * Get report configs created in the organization. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Custom Reports** under the Custom Reports 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.GetReportConfigsRequest} request * @param {BetaApIsClient.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.betaApIs.getReportConfigs() */ getReportConfigs(request?: Samsara.GetReportConfigsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getReportConfigs; /** * Get datasets for custom reports. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Custom Reports** under the Custom Reports 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.GetDatasetsRequest} request * @param {BetaApIsClient.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.betaApIs.getDatasets() */ getDatasets(request?: Samsara.GetDatasetsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getDatasets; /** * Get custom report runs created by the user. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Custom Reports** under the Custom Reports 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.GetReportRunsRequest} request * @param {BetaApIsClient.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.betaApIs.getReportRuns() */ getReportRuns(request?: Samsara.GetReportRunsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getReportRuns; /** * Triggers a new custom report run based on the provided configuration. * * Rate limit: 50 requests/hour (learn more about rate limits here). * * To use this endpoint, select **Write Custom Reports** under the Custom Reports 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.ReportsCreateReportRunRequestBody} request * @param {BetaApIsClient.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.betaApIs.createReportRun({ * reportConfig: {} * }) */ createReportRun(request: Samsara.ReportsCreateReportRunRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createReportRun; /** * Get data for the given custom report run. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Custom Reports** under the Custom Reports 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.GetReportRunDataRequest} request * @param {BetaApIsClient.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.betaApIs.getReportRunData({ * id: "id" * }) */ getReportRunData(request: Samsara.GetReportRunDataRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getReportRunData; /** * List ridership passengers by tag. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Ridership** under the Ridership 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.ListRidershipPassengersRequest} request * @param {BetaApIsClient.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.betaApIs.listRidershipPassengers({ * tagId: "tagId" * }) */ listRidershipPassengers(request: Samsara.ListRidershipPassengersRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listRidershipPassengers; /** * Create a new ridership passenger. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Ridership** under the Ridership 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.RidershipPassengersCreateRidershipPassengerRequestBody} request * @param {BetaApIsClient.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.betaApIs.createRidershipPassenger({ * firstName: "John", * lastName: "Doe" * }) */ createRidershipPassenger(request: Samsara.RidershipPassengersCreateRidershipPassengerRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createRidershipPassenger; /** * Update a ridership passenger by ID. All provided fields will overwrite existing values (PUT semantics). The id query parameter accepts either a Samsara UUID or an external ID in key:value format (e.g. student:STU-001). * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Ridership** under the Ridership 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.RidershipPassengersUpdateRidershipPassengerRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateRidershipPassenger({ * id: "id", * firstName: "John", * lastName: "Doe" * }) */ updateRidershipPassenger(request: Samsara.RidershipPassengersUpdateRidershipPassengerRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateRidershipPassenger; /** * Delete a ridership passenger by ID. The id query parameter accepts either a Samsara UUID or an external ID in key:value format (e.g. student:STU-001). * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Ridership** under the Ridership 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.DeleteRidershipPassengerRequest} request * @param {BetaApIsClient.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.betaApIs.deleteRidershipPassenger({ * id: "id" * }) */ deleteRidershipPassenger(request: Samsara.DeleteRidershipPassengerRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteRidershipPassenger; /** * Get a single ridership passenger by ID. The ID can be a Samsara UUID or an external ID in `key:value` format. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Ridership** under the Ridership 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.GetRidershipPassengerRequest} request * @param {BetaApIsClient.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.betaApIs.getRidershipPassenger({ * id: "id" * }) */ getRidershipPassenger(request: Samsara.GetRidershipPassengerRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getRidershipPassenger; /** * List all route setups for a ridership account. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Ridership** under the Ridership 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.ListRidershipRouteSetupsRequest} request * @param {BetaApIsClient.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.betaApIs.listRidershipRouteSetups({ * accountId: "accountId" * }) */ listRidershipRouteSetups(request: Samsara.ListRidershipRouteSetupsRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __listRidershipRouteSetups; /** * Create the passenger assignment setup for a route. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Ridership** under the Ridership 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.RidershipRouteSetupsCreateRidershipRouteSetupRequestBody} request * @param {BetaApIsClient.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.betaApIs.createRidershipRouteSetup({ * passengers: [{ * passengerId: "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d" * }], * routeId: "123456" * }) */ createRidershipRouteSetup(request: Samsara.RidershipRouteSetupsCreateRidershipRouteSetupRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __createRidershipRouteSetup; /** * Update (replace) the passenger assignment setup for a route. All existing assignments will be replaced with the provided assignments. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Ridership** under the Ridership 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.RidershipRouteSetupsUpdateRidershipRouteSetupRequestBody} request * @param {BetaApIsClient.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.betaApIs.updateRidershipRouteSetup({ * routeId: "routeId", * passengers: [{ * passengerId: "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d" * }] * }) */ updateRidershipRouteSetup(request: Samsara.RidershipRouteSetupsUpdateRidershipRouteSetupRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __updateRidershipRouteSetup; /** * Delete the passenger assignment setup for a route. * * Rate limit: 100 requests/min (learn more about rate limits here). * * To use this endpoint, select **Write Ridership** under the Ridership 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.DeleteRidershipRouteSetupRequest} request * @param {BetaApIsClient.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.betaApIs.deleteRidershipRouteSetup({ * routeId: "routeId" * }) */ deleteRidershipRouteSetup(request: Samsara.DeleteRidershipRouteSetupRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __deleteRidershipRouteSetup; /** * Get the passenger assignment setup for a route by route ID. * * Rate limit: 10 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Read Ridership** under the Ridership 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.GetRidershipRouteSetupRequest} request * @param {BetaApIsClient.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.betaApIs.getRidershipRouteSetup({ * routeId: "routeId" * }) */ getRidershipRouteSetup(request: Samsara.GetRidershipRouteSetupRequest, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __getRidershipRouteSetup; /** * Asynchronously update eventState, context labels, and/or behavior labels for one or more Safety Events. Returns 202 Accepted immediately. State changes propagate asynchronously; use GET /safety-events to confirm updated state. If any safetyEventIds are not found, the entire request fails with 404 before any mutations are executed.If both eventState and label fields are provided, the two mutations execute serially and are not transactional — a label mutation failure will not roll back a successful state change. * * Rate limit: 5 requests/sec (learn more about rate limits here). * * To use this endpoint, select **Write Safety Events & Scores** under the Safety & Cameras 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.SafetyEventsV2PatchSafetyEventsV2BatchRequestBody} request * @param {BetaApIsClient.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.betaApIs.patchSafetyEventsV2Batch({ * safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"] * }) */ patchSafetyEventsV2Batch(request: Samsara.SafetyEventsV2PatchSafetyEventsV2BatchRequestBody, requestOptions?: BetaApIsClient.RequestOptions): core.HttpResponsePromise; private __patchSafetyEventsV2Batch; }