# Reference ## Addresses

client.addresses.list({ ...params }) -> core.Page<Samsara.Address, Samsara.ListAddressesResponse>

#### 📝 Description

Returns a list of all addresses in an organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Addresses** under the Addresses category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript const pageableResponse = await client.addresses.list(); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.addresses.list(); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```

#### ⚙️ Parameters

**request:** `Samsara.ListAddressesRequest`

**requestOptions:** `AddressesClient.RequestOptions`

client.addresses.create({ ...params }) -> Samsara.AddressResponse

#### 📝 Description

Creates a new address in the organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Addresses** under the Addresses category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.addresses.create({ formattedAddress: "350 Rhode Island St, San Francisco, CA", geofence: {}, name: "Samsara HQ" }); ```

#### ⚙️ Parameters

**request:** `Samsara.CreateAddressRequest`

**requestOptions:** `AddressesClient.RequestOptions`

client.addresses.get({ ...params }) -> Samsara.AddressResponse

#### 📝 Description

Returns a specific address. **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 Addresses** under the Addresses category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.addresses.get({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetAddressesRequest`

**requestOptions:** `AddressesClient.RequestOptions`

client.addresses.delete({ ...params }) -> void

#### 📝 Description

Delete a specific address. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Addresses** under the Addresses category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.addresses.delete({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteAddressesRequest`

**requestOptions:** `AddressesClient.RequestOptions`

client.addresses.update({ ...params }) -> Samsara.AddressResponse

#### 📝 Description

Update a specific address. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Addresses** under the Addresses category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.addresses.update({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.UpdateAddressRequest`

**requestOptions:** `AddressesClient.RequestOptions`

## Beta APIs

client.betaApIs.getVoiceSessions({ ...params }) -> Samsara.AgentStudioVoiceSessionsGetVoiceSessionsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getVoiceSessions(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVoiceSessionsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getVoiceSessionsStream({ ...params }) -> Samsara.AgentStudioVoiceSessionsGetVoiceSessionsStreamResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getVoiceSessionsStream({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVoiceSessionsStreamRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getDepreciationTransactions({ ...params }) -> Samsara.DepreciationGetDepreciationTransactionsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getDepreciationTransactions(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDepreciationTransactionsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getAssetsInputs({ ...params }) -> Samsara.AssetsInputsGetAssetsInputsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getAssetsInputs({ type: "auxInput1", startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetAssetsInputsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getAempEquipmentList({ ...params }) -> Samsara.AempEquipmentGetAempEquipmentListResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getAempEquipmentList({ pageNumber: "pageNumber" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetAempEquipmentListRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getDriverEfficiency({ ...params }) -> Samsara.DriverEfficienciesResponse

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getDriverEfficiency(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriverEfficiencyRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.patchEquipment({ ...params }) -> Samsara.EquipmentPatchEquipmentResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.patchEquipment({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EquipmentPatchEquipmentRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getHosEldEvents({ ...params }) -> Samsara.HosEldEventsGetHosEldEventsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getHosEldEvents({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetHosEldEventsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateEngineImmobilizerState({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateEngineImmobilizerState({ id: 1000000, relayStates: [{ id: "relay1", isOpen: false }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.EngineImmobilizerUpdateEngineImmobilizerStateRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getJobs({ ...params }) -> Samsara.JobsGetJobsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getJobs(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetJobsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createJob({ ...params }) -> Samsara.JobsCreateJobResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript 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" } }); ```

#### ⚙️ Parameters

**request:** `Samsara.JobsCreateJobRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteJob({ ...params }) -> Samsara.JobsDeleteJobResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteJob({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteJobRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.patchJob({ ...params }) -> Samsara.JobsPatchJobResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.patchJob({ id: "id", job: {} }); ```

#### ⚙️ Parameters

**request:** `Samsara.JobsPatchJobRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getDetections({ ...params }) -> Samsara.DetectionLogGetDetectionsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getDetections({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDetectionsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getDevices({ ...params }) -> Samsara.DevicesGetDevicesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getDevices(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDevicesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listAssetSharingAgreements({ ...params }) -> Samsara.AssetSharingAgreementsListAssetSharingAgreementsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listAssetSharingAgreements(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListAssetSharingAgreementsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createAssetSharingAgreement({ ...params }) -> Samsara.AssetSharingAgreementsCreateAssetSharingAgreementResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createAssetSharingAgreement({ operator: "provider", providerDataPackages: ["all", "maintenance", "maintenance", "maintenance"], recipientDataPackages: ["all", "reefer", "all", "maintenance"], recipientOrganizationId: "456", recipientOrganizationName: "Acme Logistics" }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetSharingAgreementsCreateAssetSharingAgreementRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteAssetSharingAgreement({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteAssetSharingAgreement({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteAssetSharingAgreementRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.acceptAssetSharingAgreement({ ...params }) -> Samsara.AssetSharingAgreementsAcceptAssetSharingAgreementResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.acceptAssetSharingAgreement({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.AcceptAssetSharingAgreementRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listSharedAssets({ ...params }) -> Samsara.AssetSharingAgreementsListSharedAssetsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listSharedAssets({ dsaId: "dsaId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListSharedAssetsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createSharedAssetsBatch({ ...params }) -> Samsara.AssetSharingAgreementsCreateSharedAssetsBatchResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createSharedAssetsBatch({ dsaId: "dsaId", data: [{ serial: "GVJC3VXXXX" }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetSharingAgreementsCreateSharedAssetsBatchRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateSharedAssetsBatch({ ...params }) -> Samsara.AssetSharingAgreementsUpdateSharedAssetsBatchResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateSharedAssetsBatch({ data: [{ endTime: "2025-01-13T10:00:00Z", id: "11111111-1111-1111-1111-111111111111" }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetSharingAgreementsUpdateSharedAssetsBatchRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.cancelSharedAssetsBatch({ ...params }) -> Samsara.AssetSharingAgreementsCancelSharedAssetsBatchResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.cancelSharedAssetsBatch({ data: [{ id: "12345" }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetSharingAgreementsCancelSharedAssetsBatchRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.cancelAssetSharingAgreement({ ...params }) -> Samsara.AssetSharingAgreementsCancelAssetSharingAgreementResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.cancelAssetSharingAgreement({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.CancelAssetSharingAgreementRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.rejectAssetSharingAgreement({ ...params }) -> Samsara.AssetSharingAgreementsRejectAssetSharingAgreementResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.rejectAssetSharingAgreement({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.RejectAssetSharingAgreementRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listAssetAssignments({ ...params }) -> Samsara.AssetAssignmentsListAssetAssignmentsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listAssetAssignments(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListAssetAssignmentsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createAssetAssignment({ ...params }) -> Samsara.AssetAssignmentsCreateAssetAssignmentResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createAssetAssignment({ assetId: "281474978683353", assigneeId: "494123", assigneeType: "driver" }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetAssignmentsCreateAssetAssignmentRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.unassignAssetAssignment({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.unassignAssetAssignment({ assetId: "281474978683353" }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetAssignmentsUnassignAssetAssignmentRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listAssociations({ ...params }) -> Samsara.AssociationsListAssociationsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listAssociations({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListAssociationsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listDeviceRecoveryMissingAssets({ ...params }) -> Samsara.DeviceRecoveryListDeviceRecoveryMissingAssetsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listDeviceRecoveryMissingAssets(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListDeviceRecoveryMissingAssetsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.markAssetMissing({ ...params }) -> Samsara.DeviceRecoveryMarkAssetMissingResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.markAssetMissing({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeviceRecoveryMarkAssetMissingRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.recoverAsset({ ...params }) -> Samsara.DeviceRecoveryRecoverAssetResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.recoverAsset({ id: "id", missing_reason: "MISPLACED", recovery_status: "YES", status: "RECOVERED" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeviceRecoveryRecoverAssetRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.resolveAssignmentByDetails({ ...params }) -> Samsara.ResolveAssignmentByDetailsResolveAssignmentByDetailsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.resolveAssignmentByDetails({ driverName: "Jane Doe", vehicleId: "281474978683353" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ResolveAssignmentByDetailsResolveAssignmentByDetailsRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.postDriverWorkflowAssignment({ ...params }) -> Samsara.DriverWorkflowAssignmentsPostDriverWorkflowAssignmentResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.postDriverWorkflowAssignment({ workflowId: "a4db8702-79d5-4396-a717-e301d52ecc11" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DriverWorkflowAssignmentsPostDriverWorkflowAssignmentRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listDriverWorkflows({ ...params }) -> Samsara.DriverWorkflowsListDriverWorkflowsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listDriverWorkflows(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListDriverWorkflowsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.setEquipmentDigitalOutput({ ...params }) -> Samsara.EquipmentOutputControlSetEquipmentDigitalOutputResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.setEquipmentDigitalOutput({ id: 1000000, pinId: 1, state: true }); ```

#### ⚙️ Parameters

**request:** `Samsara.EquipmentOutputControlSetEquipmentDigitalOutputRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getFleetInstallerPhotoUploads({ ...params }) -> Samsara.FleetInstallerPhotoUploadsGetFleetInstallerPhotoUploadsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getFleetInstallerPhotoUploads(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFleetInstallerPhotoUploadsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.postFleetInstallerPhotoUpload({ ...params }) -> Samsara.FleetInstallerPhotoUploadsPostFleetInstallerPhotoUploadResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.postFleetInstallerPhotoUpload({ contentMd5: "rL0Y20zC+Fzt72VPzMSk2A==", deviceId: "281474977961335", fileFormatType: "imageJpeg", fileName: "front_camera_install.jpg", hardwareType: "vehicleGateway", photoType: "installPhoto", sizeBytes: 482193 }); ```

#### ⚙️ Parameters

**request:** `Samsara.FleetInstallerPhotoUploadsPostFleetInstallerPhotoUploadRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.postFleetInstallerPhotoUploadComplete({ ...params }) -> Samsara.FleetInstallerPhotoUploadsPostFleetInstallerPhotoUploadCompleteResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.postFleetInstallerPhotoUploadComplete({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.PostFleetInstallerPhotoUploadCompleteRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listVendorCategories({ ...params }) -> Samsara.MaintenanceVendorsListVendorCategoriesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listVendorCategories(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListVendorCategoriesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listMaintenanceVendors({ ...params }) -> Samsara.MaintenanceVendorsListMaintenanceVendorsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listMaintenanceVendors(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListMaintenanceVendorsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listTachographLiveData({ ...params }) -> Samsara.EntityTachographLiveDataRecordsServiceListTachographLiveDataResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listTachographLiveData(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListTachographLiveDataRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.postTachographFileUpload({ ...params }) -> Samsara.TachographFileUploadsPostTachographFileUploadResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.postTachographFileUpload({ contentMd5: "rL0Y20zC+Fzt72VPzMSk2A==", contentType: "application/octet-stream", fileSizeBytes: 8192, fileType: "driverCard" }); ```

#### ⚙️ Parameters

**request:** `Samsara.TachographFileUploadsPostTachographFileUploadRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getEngineImmobilizerStates({ ...params }) -> Samsara.EngineImmobilizerGetEngineImmobilizerStatesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getEngineImmobilizerStates({ vehicleIds: "vehicleIds", startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetEngineImmobilizerStatesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createFunction({ ...params }) -> Samsara.FunctionsCreateFunctionResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createFunction({ config: { handler: "index.handler" }, name: "my-function" }); ```

#### ⚙️ Parameters

**request:** `Samsara.FunctionsCreateFunctionRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getFunctionStorageFile({ ...params }) -> Samsara.FunctionsStorageGetFunctionStorageFileResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getFunctionStorageFile({ name: "name" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFunctionStorageFileRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createFunctionStorageFile({ ...params }) -> Samsara.FunctionsStorageCreateFunctionStorageFileResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createFunctionStorageFile({ name: "my-script.js" }); ```

#### ⚙️ Parameters

**request:** `Samsara.FunctionsStorageCreateFunctionStorageFileRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateFunctionStorageFile({ ...params }) -> Samsara.FunctionsStorageUpdateFunctionStorageFileResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateFunctionStorageFile({ name: "name" }); ```

#### ⚙️ Parameters

**request:** `Samsara.UpdateFunctionStorageFileRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteFunctionStorageFile({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteFunctionStorageFile({ name: "name" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteFunctionStorageFileRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listFunctionsStorageFiles({ ...params }) -> Samsara.FunctionsStorageListFunctionsStorageFilesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listFunctionsStorageFiles(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListFunctionsStorageFilesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getFunction({ ...params }) -> Samsara.FunctionsGetFunctionResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getFunction({ name: "name" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFunctionRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteFunction({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteFunction({ name: "name" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteFunctionRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.patchFunction({ ...params }) -> Samsara.FunctionsPatchFunctionResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.patchFunction({ name: "name", lastUpdateTimestampMs: 1609459200000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.FunctionsPatchFunctionRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deployFunction({ ...params }) -> Samsara.FunctionsDeployFunctionResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deployFunction({ name: "name" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeployFunctionRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getFunctionLogs({ ...params }) -> Samsara.FunctionsGetFunctionLogsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getFunctionLogs({ name: "name", startTime: "2024-01-15T09:30:00Z", endTime: "2024-01-15T09:30:00Z" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFunctionLogsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.startFunctionRun({ ...params }) -> Samsara.FunctionsStartFunctionRunResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.startFunctionRun({ name: "name", paramsOverride: {} }); ```

#### ⚙️ Parameters

**request:** `Samsara.FunctionsStartFunctionRunRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getFunctionRun({ ...params }) -> Samsara.FunctionsGetFunctionRunResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getFunctionRun({ name: "name", correlationId: "correlationId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFunctionRunRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.pairGateways({ ...params }) -> Samsara.GatewaysPairGatewaysResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.pairGateways({ pairs: [{ deviceSerial: "GFRV-43N-VGX", gatewaySerial: "GFRV-43N-VGX" }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.GatewaysPairGatewaysRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listIssues({ ...params }) -> Samsara.EntityGroundIntelligenceIssuesServiceListIssuesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listIssues(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListIssuesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateGroundIntelligenceIssue({ ...params }) -> Samsara.EntityGroundIntelligenceIssuesServiceUpdateGroundIntelligenceIssueResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateGroundIntelligenceIssue({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityGroundIntelligenceIssuesServiceUpdateGroundIntelligenceIssueRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createWatchpoint({ ...params }) -> Samsara.EntityWatchpointsServiceCreateWatchpointResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createWatchpoint({ location: { latitude: 37.7749, longitude: -122.4194 }, mode: "justOnce", observationType: "roadDefect" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityWatchpointsServiceCreateWatchpointRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateWatchpoint({ ...params }) -> Samsara.EntityWatchpointsServiceUpdateWatchpointResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateWatchpoint({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityWatchpointsServiceUpdateWatchpointRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateShippingDocs({ ...params }) -> Samsara.HosDailyLogsUpdateShippingDocsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateShippingDocs({ hosDate: "hosDate", driverID: "driverID", shippingDocs: "ShippingID1, ShippingID2" }); ```

#### ⚙️ Parameters

**request:** `Samsara.HosDailyLogsUpdateShippingDocsRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listPlanOrders({ ...params }) -> Samsara.PlanOrdersListPlanOrdersResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listPlanOrders({ planId: "planId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListPlanOrdersRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deletePlanOrders({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deletePlanOrders({ planId: "planId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeletePlanOrdersRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listHubRouteTemplates({ ...params }) -> Samsara.HubRouteTemplatesListHubRouteTemplatesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listHubRouteTemplates({ hubId: "hubId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListHubRouteTemplatesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createHubRouteTemplate({ ...params }) -> Samsara.HubRouteTemplatesCreateHubRouteTemplateResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createHubRouteTemplate({ hubId: "550e8400-e29b-41d4-a716-446655440000", name: "Downtown Delivery Route" }); ```

#### ⚙️ Parameters

**request:** `Samsara.HubRouteTemplatesCreateHubRouteTemplateRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteHubRouteTemplate({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteHubRouteTemplate({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteHubRouteTemplateRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateHubRouteTemplate({ ...params }) -> Samsara.HubRouteTemplatesUpdateHubRouteTemplateResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateHubRouteTemplate({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.HubRouteTemplatesUpdateHubRouteTemplateRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listParts({ ...params }) -> Samsara.EntityPartDefinitionsServiceListPartsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listParts(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListPartsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createPart({ ...params }) -> Samsara.EntityPartDefinitionsServiceCreatePartResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createPart({ partNumber: "12345" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityPartDefinitionsServiceCreatePartRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deletePart({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deletePart({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeletePartRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updatePart({ ...params }) -> Samsara.EntityPartDefinitionsServiceUpdatePartResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updatePart({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityPartDefinitionsServiceUpdatePartRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listPartInventory({ ...params }) -> Samsara.EntityPartInventoryLocationsServiceListPartInventoryResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listPartInventory(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListPartInventoryRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createPartInventoryLocation({ ...params }) -> Samsara.EntityPartInventoryLocationsServiceCreatePartInventoryLocationResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createPartInventoryLocation(); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityPartInventoryLocationsServiceCreatePartInventoryLocationRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updatePartInventoryLocation({ ...params }) -> Samsara.EntityPartInventoryLocationsServiceUpdatePartInventoryLocationResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updatePartInventoryLocation(); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityPartInventoryLocationsServiceUpdatePartInventoryLocationRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createStockMovement({ ...params }) -> Samsara.CreateStockMovementActionServiceCreateStockMovementResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createStockMovement({ movementType: "12345", partSamsaraId: "12345", quantity: 123.45 }); ```

#### ⚙️ Parameters

**request:** `Samsara.CreateStockMovementActionServiceCreateStockMovementRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listPartTransactions({ ...params }) -> Samsara.EntityInventoryTransactionsServiceListPartTransactionsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listPartTransactions({ happenedAtTimeStart: "happenedAtTimeStart" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListPartTransactionsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.resolvePreventiveMaintenance({ ...params }) -> Samsara.ResolvePreventiveMaintenanceActionServiceResolvePreventiveMaintenanceResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.resolvePreventiveMaintenance(); ```

#### ⚙️ Parameters

**request:** `Samsara.ResolvePreventiveMaintenanceActionServiceResolvePreventiveMaintenanceRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listPreventiveMaintenanceSchedules({ ...params }) -> Samsara.EntityPreventativeMaintenanceSchedulesServiceListPreventiveMaintenanceSchedulesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listPreventiveMaintenanceSchedules(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListPreventiveMaintenanceSchedulesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listUpcomingPreventiveMaintenance({ ...params }) -> Samsara.EntityUpcomingPreventativeMaintenancesServiceListUpcomingPreventiveMaintenanceResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listUpcomingPreventiveMaintenance(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListUpcomingPreventiveMaintenanceRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateUpcomingPreventiveMaintenance({ ...params }) -> Samsara.EntityUpcomingPreventativeMaintenancesServiceUpdateUpcomingPreventiveMaintenanceResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateUpcomingPreventiveMaintenance(); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityUpcomingPreventativeMaintenancesServiceUpdateUpcomingPreventiveMaintenanceRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listPurchaseOrders({ ...params }) -> Samsara.EntityPurchaseOrdersServiceListPurchaseOrdersResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listPurchaseOrders({ ids: "281474976710656", poNumbers: "PO-1001", vendorIds: "281474976710656", endTime: "2026-07-31T00:00:00Z", startTime: "2026-07-01T00:00:00Z" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListPurchaseOrdersRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createPurchaseOrder({ ...params }) -> Samsara.EntityPurchaseOrdersServiceCreatePurchaseOrderResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createPurchaseOrder({ orderStatus: "Unknown", vendorId: "281474976710656" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityPurchaseOrdersServiceCreatePurchaseOrderRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deletePurchaseOrder({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deletePurchaseOrder({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeletePurchaseOrderRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updatePurchaseOrder({ ...params }) -> Samsara.EntityPurchaseOrdersServiceUpdatePurchaseOrderResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updatePurchaseOrder({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityPurchaseOrdersServiceUpdatePurchaseOrderRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listMaintenanceSites({ ...params }) -> Samsara.EntityMaintenanceSitesServiceListMaintenanceSitesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listMaintenanceSites(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListMaintenanceSitesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createMaintenanceSite({ ...params }) -> Samsara.EntityMaintenanceSitesServiceCreateMaintenanceSiteResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createMaintenanceSite({ name: "12345", siteCode: "12345", siteType: "Unknown" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityMaintenanceSitesServiceCreateMaintenanceSiteRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateMaintenanceSite({ ...params }) -> Samsara.EntityMaintenanceSitesServiceUpdateMaintenanceSiteResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateMaintenanceSite({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityMaintenanceSitesServiceUpdateMaintenanceSiteRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listTimeEntries({ ...params }) -> Samsara.EntityTimeEntriesServiceListTimeEntriesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listTimeEntries({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListTimeEntriesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listWarranties({ ...params }) -> Samsara.EntityWarrantiesServiceListWarrantiesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listWarranties(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListWarrantiesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createWarranty({ ...params }) -> Samsara.EntityWarrantiesServiceCreateWarrantyResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createWarranty({ name: "12345" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityWarrantiesServiceCreateWarrantyRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteWarranty({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteWarranty({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteWarrantyRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateWarranty({ ...params }) -> Samsara.EntityWarrantiesServiceUpdateWarrantyResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateWarranty({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityWarrantiesServiceUpdateWarrantyRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listWarrantyAssetAssignments({ ...params }) -> Samsara.EntityWarrantyAssetAssignmentsServiceListWarrantyAssetAssignmentsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listWarrantyAssetAssignments({ warrantyId: "warrantyId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListWarrantyAssetAssignmentsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.replaceWarrantyAssetAssignments({ ...params }) -> Samsara.ReplaceWarrantyAssetAssignmentsActionServiceReplaceWarrantyAssetAssignmentsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.replaceWarrantyAssetAssignments(); ```

#### ⚙️ Parameters

**request:** `Samsara.ReplaceWarrantyAssetAssignmentsActionServiceReplaceWarrantyAssetAssignmentsRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listWarrantyClaims({ ...params }) -> Samsara.EntityWarrantyClaimsServiceListWarrantyClaimsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listWarrantyClaims(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListWarrantyClaimsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createWarrantyClaim({ ...params }) -> Samsara.EntityWarrantyClaimsServiceCreateWarrantyClaimResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createWarrantyClaim({ assetId: "281474976710656" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityWarrantyClaimsServiceCreateWarrantyClaimRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteWarrantyClaim({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteWarrantyClaim({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteWarrantyClaimRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateWarrantyClaim({ ...params }) -> Samsara.EntityWarrantyClaimsServiceUpdateWarrantyClaimResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateWarrantyClaim({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.EntityWarrantyClaimsServiceUpdateWarrantyClaimRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getWorkOrderTemplates({ ...params }) -> Samsara.WorkOrdersGetWorkOrderTemplatesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getWorkOrderTemplates(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetWorkOrderTemplatesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getPlaces({ ...params }) -> Samsara.PlacesGetPlacesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getPlaces(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetPlacesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.postPlace({ ...params }) -> Samsara.PlacesPostPlaceResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.postPlace({ address: "123 Main St, Oakland, CA", geofence: {}, name: "Oakland Yard" }); ```

#### ⚙️ Parameters

**request:** `Samsara.PlacesPostPlaceRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deletePlace({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deletePlace({ placeId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeletePlaceRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.patchPlace({ ...params }) -> Samsara.PlacesPatchPlaceResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.patchPlace(); ```

#### ⚙️ Parameters

**request:** `Samsara.PlacesPatchPlaceRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getPlaceDeletions({ ...params }) -> Samsara.PlacesGetPlaceDeletionsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getPlaceDeletions(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetPlaceDeletionsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getPlaceGeocode({ ...params }) -> Samsara.PlacesGetPlaceGeocodeResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getPlaceGeocode({ address: "address" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetPlaceGeocodeRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getPlaceGeofence({ ...params }) -> Samsara.PlacesGetPlaceGeofenceResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getPlaceGeofence({ latitude: 1.1, longitude: 1.1 }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetPlaceGeofenceRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listPreferredStations({ ...params }) -> Samsara.PreferredStationsListPreferredStationsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listPreferredStations(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListPreferredStationsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.postPreferredStation({ ...params }) -> Samsara.PreferredStationsPostPreferredStationResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.postPreferredStation({ address: { city: "Green River", country: "US", line1: "8901 US Hwy 374", postalCode: "82935" }, externalIds: { "key": "value" }, name: "Station #432" }); ```

#### ⚙️ Parameters

**request:** `Samsara.PreferredStationsPostPreferredStationRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deletePreferredStation({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deletePreferredStation({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeletePreferredStationRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.patchPreferredStation({ ...params }) -> Samsara.PreferredStationsPatchPreferredStationResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.patchPreferredStation({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.PreferredStationsPatchPreferredStationRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getPreferredStation({ ...params }) -> Samsara.PreferredStationsGetPreferredStationResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getPreferredStation({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetPreferredStationRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getQualificationRecords({ ...params }) -> Samsara.QualificationsGetQualificationRecordsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getQualificationRecords(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetQualificationRecordsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.postQualificationRecord({ ...params }) -> Samsara.QualificationsPostQualificationRecordResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript 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" } }); ```

#### ⚙️ Parameters

**request:** `Samsara.QualificationsPostQualificationRecordRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteQualificationRecord({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteQualificationRecord({ id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7" }); ```

#### ⚙️ Parameters

**request:** `Samsara.QualificationsDeleteQualificationRecordRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.patchQualificationRecord({ ...params }) -> Samsara.QualificationsPatchQualificationRecordResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.patchQualificationRecord({ id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", issueDate: "2025-08-27T10:20:30Z", owner: { entityType: "worker", id: "281474" } }); ```

#### ⚙️ Parameters

**request:** `Samsara.QualificationsPatchQualificationRecordRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.archiveQualificationRecord({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.archiveQualificationRecord({ id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7" }); ```

#### ⚙️ Parameters

**request:** `Samsara.QualificationsArchiveQualificationRecordRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getQualificationRecordsStream({ ...params }) -> Samsara.QualificationsGetQualificationRecordsStreamResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getQualificationRecordsStream({ entityType: "worker", startTime: "2024-01-15T09:30:00Z" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetQualificationRecordsStreamRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.unarchiveQualificationRecord({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.unarchiveQualificationRecord({ id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7" }); ```

#### ⚙️ Parameters

**request:** `Samsara.QualificationsUnarchiveQualificationRecordRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getQualificationTypes({ ...params }) -> Samsara.QualificationsGetQualificationTypesResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getQualificationTypes({ entityType: "worker" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetQualificationTypesRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.postReadings({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.postReadings({ data: [{ entityType: "asset", happenedAtTime: "2023-10-27T10:00:00Z", readingId: "airInletPressure", value: { "key": "value" } }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.ReadingsPostReadingsRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getReportConfigs({ ...params }) -> Samsara.ReportsGetReportConfigsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getReportConfigs(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetReportConfigsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getDatasets({ ...params }) -> Samsara.ReportsGetDatasetsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getDatasets(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDatasetsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getReportRuns({ ...params }) -> Samsara.ReportsGetReportRunsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getReportRuns(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetReportRunsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createReportRun({ ...params }) -> Samsara.ReportsCreateReportRunResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createReportRun({ reportConfig: {} }); ```

#### ⚙️ Parameters

**request:** `Samsara.ReportsCreateReportRunRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getReportRunData({ ...params }) -> Samsara.ReportsGetReportRunDataResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getReportRunData({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetReportRunDataRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listRidershipPassengers({ ...params }) -> Samsara.RidershipPassengersListRidershipPassengersResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listRidershipPassengers({ tagId: "tagId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListRidershipPassengersRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createRidershipPassenger({ ...params }) -> Samsara.RidershipPassengersCreateRidershipPassengerResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createRidershipPassenger({ firstName: "John", lastName: "Doe" }); ```

#### ⚙️ Parameters

**request:** `Samsara.RidershipPassengersCreateRidershipPassengerRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateRidershipPassenger({ ...params }) -> Samsara.RidershipPassengersUpdateRidershipPassengerResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateRidershipPassenger({ id: "id", firstName: "John", lastName: "Doe" }); ```

#### ⚙️ Parameters

**request:** `Samsara.RidershipPassengersUpdateRidershipPassengerRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteRidershipPassenger({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteRidershipPassenger({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteRidershipPassengerRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getRidershipPassenger({ ...params }) -> Samsara.RidershipPassengersGetRidershipPassengerResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getRidershipPassenger({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetRidershipPassengerRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.listRidershipRouteSetups({ ...params }) -> Samsara.RidershipRouteSetupsListRidershipRouteSetupsResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.listRidershipRouteSetups({ accountId: "accountId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListRidershipRouteSetupsRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.createRidershipRouteSetup({ ...params }) -> Samsara.RidershipRouteSetupsCreateRidershipRouteSetupResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.createRidershipRouteSetup({ passengers: [{ passengerId: "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d" }], routeId: "123456" }); ```

#### ⚙️ Parameters

**request:** `Samsara.RidershipRouteSetupsCreateRidershipRouteSetupRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.updateRidershipRouteSetup({ ...params }) -> Samsara.RidershipRouteSetupsUpdateRidershipRouteSetupResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.updateRidershipRouteSetup({ routeId: "routeId", passengers: [{ passengerId: "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d" }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.RidershipRouteSetupsUpdateRidershipRouteSetupRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.deleteRidershipRouteSetup({ ...params }) -> void

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.deleteRidershipRouteSetup({ routeId: "routeId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteRidershipRouteSetupRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.getRidershipRouteSetup({ ...params }) -> Samsara.RidershipRouteSetupsGetRidershipRouteSetupResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.getRidershipRouteSetup({ routeId: "routeId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetRidershipRouteSetupRequest`

**requestOptions:** `BetaApIsClient.RequestOptions`

client.betaApIs.patchSafetyEventsV2Batch({ ...params }) -> Samsara.SafetyEventsV2PatchSafetyEventsV2BatchResponseBody

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.betaApIs.patchSafetyEventsV2Batch({ safetyEventIds: ["bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590", "bb2ff5ab-30ad-49ec-9d2d-55ec30bbf590"] }); ```

#### ⚙️ Parameters

**request:** `Samsara.SafetyEventsV2PatchSafetyEventsV2BatchRequestBody`

**requestOptions:** `BetaApIsClient.RequestOptions`

## Alerts

client.alerts.getConfigurations({ ...params }) -> Samsara.AlertsGetConfigurationsResponseBody

#### 📝 Description

Get specified Alert Configurations. The following trigger types are API enabled and will show up in the results: Vehicle Speed Ambient Temperature Fuel Level (Percentage) Vehicle DEF Level (Percentage) Vehicle Battery Gateway Unplugged Dashcam Disconnected Camera Connector Disconnected Asset starts moving Inside Geofence Outside Geofence Unassigned Driving Driver HOS Violation Vehicle Engine Idle Asset Engine On Asset Engine Off Harsh Event Scheduled Maintenance Scheduled Maintenance by Odometer Scheduled Maintenance by Engine Hours Out of Route GPS Signal Loss Cell Signal Loss Fault Code Tire Faults Gateway Disconnected Panic Button Tampering Detected Asset Reading If vehicle is severely speeding (as defined by your organization) DVIR Submitted for Asset Driver Document Submitted Driver App Sign In Driver App Sign Out Geofence Entry Geofence Exit Route Stop ETA Alert Driver Recorded A safety event occurred with a driver assigned A safety event occurred Sudden Fuel Level Rise Sudden Fuel Level Drop Scheduled Date And Time Training Assignment Due Soon Training Assignment Past Due Asset assignment past due Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts 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.

#### 🔌 Usage

```typescript await client.alerts.getConfigurations(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetConfigurationsRequest`

**requestOptions:** `AlertsClient.RequestOptions`

client.alerts.postConfigurations({ ...params }) -> Samsara.AlertsPostConfigurationsResponseBody

#### 📝 Description

Creates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts 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.

#### 🔌 Usage

```typescript await client.alerts.postConfigurations({ actions: [{ actionTypeId: 1 }], isEnabled: true, name: "My Harsh Event Alert", scope: { all: true }, triggers: [{ triggerTypeId: 1000 }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.AlertsPostConfigurationsRequestBody`

**requestOptions:** `AlertsClient.RequestOptions`

client.alerts.deleteConfigurations({ ...params }) -> void

#### 📝 Description

Delete an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts 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.

#### 🔌 Usage

```typescript await client.alerts.deleteConfigurations({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteConfigurationsRequest`

**requestOptions:** `AlertsClient.RequestOptions`

client.alerts.patchConfigurations({ ...params }) -> Samsara.AlertsPatchConfigurationsResponseBody

#### 📝 Description

Updates an alert configuration. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Alerts** under the Alerts 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.

#### 🔌 Usage

```typescript await client.alerts.patchConfigurations({ id: "e1c5dffc-c7b7-47b0-a778-6a65de638abf" }); ```

#### ⚙️ Parameters

**request:** `Samsara.AlertsPatchConfigurationsRequestBody`

**requestOptions:** `AlertsClient.RequestOptions`

client.alerts.getIncidents({ ...params }) -> Samsara.AlertsGetIncidentsResponseBody

#### 📝 Description

Get Alert Incidents for specific Alert Configurations over a specified period of time. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Alerts** under the Alerts 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.

#### 🔌 Usage

```typescript await client.alerts.getIncidents({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetIncidentsRequest`

**requestOptions:** `AlertsClient.RequestOptions`

## Assets

client.assets.list({ ...params }) -> core.Page<Samsara.AssetResponseBody, Samsara.AssetsListAssetsResponseBody>

#### 📝 Description

List all assets. Up to 300 assets will be returned per page. 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.

#### 🔌 Usage

```typescript const pageableResponse = await client.assets.list(); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.assets.list(); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```

#### ⚙️ Parameters

**request:** `Samsara.ListAssetsRequest`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.createAsset({ ...params }) -> Samsara.AssetsCreateAssetResponseBody

#### 📝 Description

Create a new asset. 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.

#### 🔌 Usage

```typescript await client.assets.createAsset(); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetsCreateAssetRequestBody`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.deleteAsset({ ...params }) -> void

#### 📝 Description

Delete an existing asset. 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.

#### 🔌 Usage

```typescript await client.assets.deleteAsset({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteAssetRequest`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.updateAsset({ ...params }) -> Samsara.AssetsUpdateAssetResponseBody

#### 📝 Description

Update an existing asset. 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.

#### 🔌 Usage

```typescript await client.assets.updateAsset({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetsUpdateAssetRequestBody`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.v1GetAllAssetCurrentLocations({ ...params }) -> Samsara.InlineResponse2002

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch current locations of all assets. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.assets.v1GetAllAssetCurrentLocations(); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetAllAssetCurrentLocationsRequest`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.v1GetAssetsReefers({ ...params }) -> Samsara.InlineResponse2003

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetches all reefers and reefer-specific stats. **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 Trailers** under the Trailers category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.assets.v1GetAssetsReefers({ startMs: 1000000, endMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetAssetsReefersRequest`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.getAssetLocation({ ...params }) -> Samsara.AssetLocationsGetAssetLocationResponseBody

#### 📝 Description

This endpoint is still on our legacy API. List historical locations for a given asset. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Equipment Statistics** 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.

#### 🔌 Usage

```typescript await client.assets.getAssetLocation({ assetId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetAssetLocationRequest`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.getAssetReefer({ ...params }) -> Samsara.AssetsGetAssetReeferResponseBody

#### 📝 Description

Fetch the reefer-specific stats of an asset. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Trailers** under the Trailers 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.

#### 🔌 Usage

```typescript await client.assets.getAssetReefer({ assetId: 1000000, startMs: 1000000, endMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetAssetReeferRequest`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.v1GetAssetLocation({ ...params }) -> Samsara.V1AssetLocationResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. List historical locations for a given asset. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.assets.v1GetAssetLocation({ asset_id: 1000000, startMs: 1000000, endMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetAssetLocationRequest`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.v1GetAssetReefer({ ...params }) -> Samsara.V1AssetReeferResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch the reefer-specific stats of an asset. **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 Trailers** under the Trailers category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.assets.v1GetAssetReefer({ asset_id: 1000000, startMs: 1000000, endMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetAssetReeferRequest`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.get({ ...params }) -> void

#### 🔌 Usage

```typescript await client.assets.get({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetAssetsRequest`

**requestOptions:** `AssetsClient.RequestOptions`

client.assets.update({ ...params }) -> void

#### 🔌 Usage

```typescript await client.assets.update({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.UpdateAssetsRequest`

**requestOptions:** `AssetsClient.RequestOptions`

## LocationAndSpeed

client.locationAndSpeed.getLocationAndSpeed({ ...params }) -> Samsara.LocationAndSpeedGetLocationAndSpeedResponseBody

#### 📝 Description

This endpoint will return asset locations and speed data that has been collected for your organization 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 the time-series data by device. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Vehicles** 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.

#### 🔌 Usage

```typescript await client.locationAndSpeed.getLocationAndSpeed(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetLocationAndSpeedRequest`

**requestOptions:** `LocationAndSpeedClient.RequestOptions`

## Attributes

client.attributes.getAttributesByEntityType({ ...params }) -> Samsara.GetAttributesByEntityTypeResponse

#### 📝 Description

Fetch all attributes in an organization associated with either drivers or assets. **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 Attributes** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.attributes.getAttributesByEntityType({ entityType: "driver" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetAttributesByEntityTypeRequest`

**requestOptions:** `AttributesClient.RequestOptions`

client.attributes.createAttribute({ ...params }) -> Samsara.AttributeExpandedResponse

#### 📝 Description

Creates a new attribute in the organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Attributes** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.attributes.createAttribute({ attributeType: "single-select", entityType: "driver", name: "License Certifications" }); ```

#### ⚙️ Parameters

**request:** `Samsara.CreateAttributeRequest`

**requestOptions:** `AttributesClient.RequestOptions`

client.attributes.getAttribute({ ...params }) -> Samsara.AttributeExpandedResponse

#### 📝 Description

Fetch an attribute by id, including all of its applications. **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 Attributes** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.attributes.getAttribute({ id: "id", entityType: "driver" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetAttributeRequest`

**requestOptions:** `AttributesClient.RequestOptions`

client.attributes.delete({ ...params }) -> void

#### 📝 Description

Delete an attribute by id, including all of its applications. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Attributes** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.attributes.delete({ id: "id", entityType: "driver" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteAttributesRequest`

**requestOptions:** `AttributesClient.RequestOptions`

client.attributes.updateAttribute({ ...params }) -> Samsara.AttributeExpandedResponse

#### 📝 Description

Updates an attribute in the organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Attributes** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.attributes.updateAttribute({ id: "id", entityType: "driver" }); ```

#### ⚙️ Parameters

**request:** `Samsara.UpdateAttributeRequest`

**requestOptions:** `AttributesClient.RequestOptions`

## Media

client.media.listUploadedMedia({ ...params }) -> Samsara.MediaRetrievalListUploadedMediaResponseBody

#### 📝 Description

This endpoint returns a list of all uploaded media (video and still images) matching query parameters, with a maximum query range of one day. Additional media can be retrieved with the [Create a media retrieval request](https://developers.samsara.com/reference/postmediaretrieval) endpoint, and they will be included in the list after they are uploaded. Urls provided by this endpoint expire in 8 hours. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Media Retrieval** 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.

#### 🔌 Usage

```typescript await client.media.listUploadedMedia({ vehicleIds: "vehicleIds", startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListUploadedMediaRequest`

**requestOptions:** `MediaClient.RequestOptions`

client.media.getMediaRetrieval({ ...params }) -> Samsara.MediaRetrievalGetMediaRetrievalResponseBody

#### 📝 Description

This endpoint returns media information corresponding to a retrieval ID. Retrieval IDs are associated to prior [media retrieval requests](https://developers.samsara.com/reference/postmediaretrieval). Urls provided by this endpoint expire in 8 hours. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Media Retrieval** 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.

#### 🔌 Usage

```typescript await client.media.getMediaRetrieval({ retrievalId: "retrievalId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetMediaRetrievalRequest`

**requestOptions:** `MediaClient.RequestOptions`

client.media.postMediaRetrieval({ ...params }) -> Samsara.MediaRetrievalPostMediaRetrievalResponseBody

#### 📝 Description

This endpoint creates an asynchronous request to upload certain media from a device. The closest available media to the requested timestamp is returned. Images, videos(both high resolution and low resolution) and hyperlapses are supported.Currently, only unblurred media is supported. If a device is offline, the requested media will be uploaded once it comes back online. Quota limits are enforced for media retrievals made through the API. The Create a media retrieval request response includes information about the media retrieval quota remaining for the organization. The media retrieval quota for the organization is reset at the beginning of each month.The quota is expressed using seconds of High Resolution video. 10 still images are equivalent to a 1 second of High Resolution footage. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Media Retrieval** 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.

#### 🔌 Usage

```typescript await client.media.postMediaRetrieval({ endTime: "2019-06-13T19:08:55Z", mediaType: "image", startTime: "2019-06-13T19:08:25Z", vehicleId: "1234" }); ```

#### ⚙️ Parameters

**request:** `Samsara.MediaRetrievalPostMediaRetrievalRequestBody`

**requestOptions:** `MediaClient.RequestOptions`

## Coaching

client.coaching.getDriverCoachAssignment({ ...params }) -> Samsara.DriverCoachAssignmentsGetDriverCoachAssignmentResponseBody

#### 📝 Description

This endpoint will return coach assignments for your organization based on the parameters passed in. Results are paginated. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Coaching** under the Coaching 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.

#### 🔌 Usage

```typescript await client.coaching.getDriverCoachAssignment(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriverCoachAssignmentRequest`

**requestOptions:** `CoachingClient.RequestOptions`

client.coaching.putDriverCoachAssignment({ ...params }) -> Samsara.DriverCoachAssignmentsPutDriverCoachAssignmentResponseBody

#### 📝 Description

This endpoint will update an existing or create a new coach-to-driver assignment for your organization based on the parameters passed in. This endpoint should only be used for existing Coach to Driver assignments. In order to remove a driver-coach-assignment for a given driver, set coachId to null Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Write Coaching** under the Coaching 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.

#### 🔌 Usage

```typescript await client.coaching.putDriverCoachAssignment({ driverId: "driverId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.PutDriverCoachAssignmentRequest`

**requestOptions:** `CoachingClient.RequestOptions`

client.coaching.getCoachingSessions({ ...params }) -> Samsara.CoachingSessionsGetCoachingSessionsResponseBody

#### 📝 Description

This endpoint will return coaching sessions for your organization based on the time parameters passed in. Results are paginated by sessions. 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. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Coaching** under the Coaching 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.

#### 🔌 Usage

```typescript await client.coaching.getCoachingSessions({ startTime: "2024-01-15T09:30:00Z" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetCoachingSessionsRequest`

**requestOptions:** `CoachingClient.RequestOptions`

## Contacts

client.contacts.listContacts({ ...params }) -> Samsara.ListContactsResponse

#### 📝 Description

Returns a list of all contacts in an organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.contacts.listContacts(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListContactsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.createContact({ ...params }) -> Samsara.ContactResponse

#### 📝 Description

Add a contact to the organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.contacts.createContact(); ```

#### ⚙️ Parameters

**request:** `Samsara.CreateContactRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.getContact({ ...params }) -> Samsara.ContactResponse

#### 📝 Description

Get a specific contact's information. **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 Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.contacts.getContact({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetContactRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.delete({ ...params }) -> void

#### 📝 Description

Delete the given contact. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.contacts.delete({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteContactsRequest`

**requestOptions:** `ContactsClient.RequestOptions`

client.contacts.updateContact({ ...params }) -> Samsara.ContactResponse

#### 📝 Description

Update a specific contact's information. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.contacts.updateContact({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.UpdateContactRequest`

**requestOptions:** `ContactsClient.RequestOptions`

## Maintenance

client.maintenance.getDefectTypes({ ...params }) -> Samsara.DvirDefectTypeGetDefectTypesResponseBody

#### 📝 Description

Get DVIR defect types. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defect Types** under the 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.

#### 🔌 Usage

```typescript await client.maintenance.getDefectTypes(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDefectTypesRequest`

**requestOptions:** `MaintenanceClient.RequestOptions`

client.maintenance.streamDefects({ ...params }) -> Samsara.DvirDefectStreamDefectsResponseBody

#### 📝 Description

Stream DVIR defects. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defects** under the 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.

#### 🔌 Usage

```typescript await client.maintenance.streamDefects({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.StreamDefectsRequest`

**requestOptions:** `MaintenanceClient.RequestOptions`

client.maintenance.getDefect({ ...params }) -> Samsara.DvirDefectGetDefectResponseBody

#### 📝 Description

Get a single DVIR defect by ID. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Defects** under the 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.

#### 🔌 Usage

```typescript await client.maintenance.getDefect({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDefectRequest`

**requestOptions:** `MaintenanceClient.RequestOptions`

client.maintenance.getDvirs({ ...params }) -> Samsara.DvirGetDvirsResponseBody

#### 📝 Description

Returns a history/feed of changed DVIRs by updatedAtTime between startTime and endTime parameters. In case of missing `endTime` parameter it will return a never ending stream of data. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read DVIRs** under the 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.

#### 🔌 Usage

```typescript await client.maintenance.getDvirs({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDvirsRequest`

**requestOptions:** `MaintenanceClient.RequestOptions`

client.maintenance.getDvir({ ...params }) -> Samsara.DvirGetDvirResponseBody

#### 📝 Description

Get a single DVIR by ID. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read DVIRs** under the 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.

#### 🔌 Usage

```typescript await client.maintenance.getDvir({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDvirRequest`

**requestOptions:** `MaintenanceClient.RequestOptions`

client.maintenance.updateDvirDefect({ ...params }) -> Samsara.DefectResponse

#### 📝 Description

Updates a given defect. Can be used to resolve a defect by marking its `isResolved` field to `true`. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Defects** under the Maintenance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.maintenance.updateDvirDefect({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DefectPatch`

**requestOptions:** `MaintenanceClient.RequestOptions`

client.maintenance.createDvir({ ...params }) -> Samsara.DvirResponse

#### 📝 Description

Creates a new mechanic DVIR in the organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.maintenance.createDvir({ authorId: "11", safetyStatus: "safe", type: "mechanic" }); ```

#### ⚙️ Parameters

**request:** `Samsara.CreateDvirRequest`

**requestOptions:** `MaintenanceClient.RequestOptions`

client.maintenance.updateDvir({ ...params }) -> Samsara.DvirResponse

#### 📝 Description

Resolves a given DVIR by marking its `isResolved` field to `true`. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.maintenance.updateDvir({ id: "id", authorId: "11", isResolved: true }); ```

#### ⚙️ Parameters

**request:** `Samsara.UpdateDvirRequest`

**requestOptions:** `MaintenanceClient.RequestOptions`

client.maintenance.v1GetFleetMaintenanceList() -> Samsara.InlineResponse2004

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get list of the vehicles with any engine faults or check light data. **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 DVIRs** under the Maintenance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.maintenance.v1GetFleetMaintenanceList(); ```

#### ⚙️ Parameters

**requestOptions:** `MaintenanceClient.RequestOptions`

## FuelAndEnergy

client.fuelAndEnergy.getDriverEfficiencyByDrivers({ ...params }) -> Samsara.DriverEfficiencyGetDriverEfficiencyByDriversResponseBody

#### 📝 Description

This endpoint will return driver efficiency data that has been collected for your organization and grouped by drivers based on the time parameters passed in. Results are paginated. **Note:** The data from this endpoint comes from the Driver Efficiency (Eco-Driving) Report. The existing [/fleet/drivers/efficiency](https://developers.samsara.com/reference/getdriverefficiency) endpoint has now been moved to Legacy. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** 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.

#### 🔌 Usage

```typescript await client.fuelAndEnergy.getDriverEfficiencyByDrivers({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriverEfficiencyByDriversRequest`

**requestOptions:** `FuelAndEnergyClient.RequestOptions`

client.fuelAndEnergy.getDriverEfficiencyByVehicles({ ...params }) -> Samsara.DriverEfficiencyGetDriverEfficiencyByVehiclesResponseBody

#### 📝 Description

This endpoint will return driver efficiency data that has been collected for your organization and grouped by vehicle drivers used based on the time parameters passed in. Results are paginated. **Note:** The data from this endpoint comes from the Driver Efficiency (Eco-Driving) Report. The existing [/fleet/drivers/efficiency](https://developers.samsara.com/reference/getdriverefficiency) endpoint has now been moved to Legacy. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** 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.

#### 🔌 Usage

```typescript await client.fuelAndEnergy.getDriverEfficiencyByVehicles({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriverEfficiencyByVehiclesRequest`

**requestOptions:** `FuelAndEnergyClient.RequestOptions`

client.fuelAndEnergy.getFuelEnergyDriverReports({ ...params }) -> Samsara.FuelEnergyGetFuelEnergyDriverReportsResponseBody

#### 📝 Description

Get fuel and energy efficiency driver reports for the requested time range. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Fuel & Energy** 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.

#### 🔌 Usage

```typescript await client.fuelAndEnergy.getFuelEnergyDriverReports({ startDate: "startDate", endDate: "endDate" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFuelEnergyDriverReportsRequest`

**requestOptions:** `FuelAndEnergyClient.RequestOptions`

client.fuelAndEnergy.getFuelEnergyVehicleReports({ ...params }) -> Samsara.FuelEnergyGetFuelEnergyVehicleReportsResponseBody

#### 📝 Description

Get fuel and energy efficiency vehicle reports for the requested time range. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Fuel & Energy** 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.

#### 🔌 Usage

```typescript await client.fuelAndEnergy.getFuelEnergyVehicleReports({ startDate: "startDate", endDate: "endDate" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFuelEnergyVehicleReportsRequest`

**requestOptions:** `FuelAndEnergyClient.RequestOptions`

client.fuelAndEnergy.postFuelPurchase({ ...params }) -> Samsara.FuelPurchasePostFuelPurchaseResponseBody

#### 📝 Description

Create a fuel purchase transaction. 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.

#### 🔌 Usage

```typescript await client.fuelAndEnergy.postFuelPurchase({ fuelQuantityLiters: "676.8", transactionLocation: "350 Rhode Island St, San Francisco, CA 94103", transactionPrice: { amount: "640.2", currency: "usd" }, transactionReference: "5454534", transactionTime: "2022-07-13T14:20:50.52-07:00" }); ```

#### ⚙️ Parameters

**request:** `Samsara.FuelPurchasePostFuelPurchaseRequestBody`

**requestOptions:** `FuelAndEnergyClient.RequestOptions`

## DriverTrailerAssignments

client.driverTrailerAssignments.getDriverTrailerAssignments({ ...params }) -> Samsara.TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody

#### 📝 Description

Get currently active driver-trailer assignments for driver. 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.

#### 🔌 Usage

```typescript await client.driverTrailerAssignments.getDriverTrailerAssignments(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriverTrailerAssignmentsRequest`

**requestOptions:** `DriverTrailerAssignmentsClient.RequestOptions`

client.driverTrailerAssignments.createDriverTrailerAssignment({ ...params }) -> Samsara.TrailerAssignmentsCreateDriverTrailerAssignmentResponseBody

#### 📝 Description

Create a new driver-trailer assignment Rate limit: 5 requests/sec (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.

#### 🔌 Usage

```typescript await client.driverTrailerAssignments.createDriverTrailerAssignment({ driverId: "494123", trailerId: "12345" }); ```

#### ⚙️ Parameters

**request:** `Samsara.TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody`

**requestOptions:** `DriverTrailerAssignmentsClient.RequestOptions`

client.driverTrailerAssignments.updateDriverTrailerAssignment({ ...params }) -> Samsara.TrailerAssignmentsUpdateDriverTrailerAssignmentResponseBody

#### 📝 Description

Update an existing driver-trailer assignment. Rate limit: 5 requests/sec (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.

#### 🔌 Usage

```typescript await client.driverTrailerAssignments.updateDriverTrailerAssignment({ id: "id", endTime: "2019-06-13T19:08:25Z" }); ```

#### ⚙️ Parameters

**request:** `Samsara.TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody`

**requestOptions:** `DriverTrailerAssignmentsClient.RequestOptions`

## DriverQrCodes

client.driverQrCodes.getDriversQrCodes({ ...params }) -> Samsara.DriverQrCodesGetDriversQrCodesResponseBody

#### 📝 Description

Get details for requested driver(s) QR code, used for driver trip assignment. Rate limit: 5 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.

#### 🔌 Usage

```typescript await client.driverQrCodes.getDriversQrCodes(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriversQrCodesRequest`

**requestOptions:** `DriverQrCodesClient.RequestOptions`

client.driverQrCodes.createDriverQrCode({ ...params }) -> Samsara.DriverQrCodesCreateDriverQrCodeResponseBody

#### 📝 Description

Assign a new QR code for the requested driver. Return error if an active QR code already exists. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write 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.

#### 🔌 Usage

```typescript await client.driverQrCodes.createDriverQrCode({ driverId: 494123 }); ```

#### ⚙️ Parameters

**request:** `Samsara.DriverQrCodesCreateDriverQrCodeRequestBody`

**requestOptions:** `DriverQrCodesClient.RequestOptions`

client.driverQrCodes.deleteDriverQrCode({ ...params }) -> void

#### 📝 Description

Revoke requested driver's currently active QR code. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write 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.

#### 🔌 Usage

```typescript await client.driverQrCodes.deleteDriverQrCode({ driverId: 494123 }); ```

#### ⚙️ Parameters

**request:** `Samsara.DriverQrCodesDeleteDriverQrCodeRequestBody`

**requestOptions:** `DriverQrCodesClient.RequestOptions`

## CarbCtc

client.carbCtc.listCarbCtcVehicles({ ...params }) -> Samsara.CarbCtcListCarbCtcVehiclesResponseBody

#### 📝 Description

Returns a paginated list of vehicles enrolled in the CARB CTC program with their latest compliance status. Results can be filtered by tag IDs and test status. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read CARB CTC Integration** under the CARB CTC Integration 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.

#### 🔌 Usage

```typescript await client.carbCtc.listCarbCtcVehicles(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListCarbCtcVehiclesRequest`

**requestOptions:** `CarbCtcClient.RequestOptions`

client.carbCtc.listCarbCtcVehicleHistory({ ...params }) -> Samsara.CarbCtcListCarbCtcVehicleHistoryResponseBody

#### 📝 Description

Returns paginated collection history for a batch of vehicles enrolled in the CARB CTC program. Use vehicle IDs from the list enrolled vehicles endpoint. Optionally filter by time range. Results are ordered by happenedAtTime descending, with vehicle ID as a tiebreaker. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read CARB CTC Integration** under the CARB CTC Integration 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.

#### 🔌 Usage

```typescript await client.carbCtc.listCarbCtcVehicleHistory({ vehicleIds: "vehicleIds" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListCarbCtcVehicleHistoryRequest`

**requestOptions:** `CarbCtcClient.RequestOptions`

## Carrier Proposed Assignments

client.carrierProposedAssignments.listCarrierProposedAssignments({ ...params }) -> Samsara.ListCarrierProposedAssignmentResponse

#### 📝 Description

Show the assignments created by the POST fleet/carrier-proposed-assignments. This endpoint will only show the assignments that are active for drivers and currently visible to them in the driver app. Once a proposed assignment has been accepted, the endpoint will not return any data. **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 Carrier-Proposed Assignments** under the Assignments category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.carrierProposedAssignments.listCarrierProposedAssignments(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListCarrierProposedAssignmentsRequest`

**requestOptions:** `CarrierProposedAssignmentsClient.RequestOptions`

client.carrierProposedAssignments.createCarrierProposedAssignment({ ...params }) -> Samsara.CarrierProposedAssignmentResponse

#### 📝 Description

Creates a new assignment that a driver can later use. Each driver can only have one future assignment. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Carrier-Proposed Assignments** under the Assignments category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.carrierProposedAssignments.createCarrierProposedAssignment({ driverId: "42", vehicleId: "123" }); ```

#### ⚙️ Parameters

**request:** `Samsara.CreateCarrierProposedAssignmentRequest`

**requestOptions:** `CarrierProposedAssignmentsClient.RequestOptions`

## Legacy APIs

client.legacyApIs.getDvirDefects({ ...params }) -> Samsara.DefectsResponse

#### 📝 Description

**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/streamdefects) instead. The endpoint will continue to function as documented.** Returns a list of DVIR defects in an organization, filtered by creation time. The maximum time period you can query for is 30 days. **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 Defects** under the Maintenance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.legacyApIs.getDvirDefects({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDvirDefectsRequest`

**requestOptions:** `LegacyApIsClient.RequestOptions`

client.legacyApIs.getDriversVehicleAssignments({ ...params }) -> Samsara.DriversVehicleAssignmentsGetDriversVehicleAssignmentsResponseBody

#### 📝 Description

**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getdrivervehicleassignments) instead. The endpoint will continue to function as documented.** Get all vehicle assignments for the requested drivers in the requested time range. The only type of assignment supported right now are assignments created through the driver app. Rate limit: 25 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.

#### 🔌 Usage

```typescript await client.legacyApIs.getDriversVehicleAssignments(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriversVehicleAssignmentsRequest`

**requestOptions:** `LegacyApIsClient.RequestOptions`

client.legacyApIs.getDvirHistory({ ...params }) -> Samsara.DvirsListResponse

#### 📝 Description

**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getdvirs) instead. The endpoint will continue to function as documented.** Returns a list of all DVIRs in an organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read DVIRs** under the Maintenance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.legacyApIs.getDvirHistory({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDvirHistoryRequest`

**requestOptions:** `LegacyApIsClient.RequestOptions`

client.legacyApIs.getVehicleIdlingReports({ ...params }) -> Samsara.IdlingReportsGetVehicleIdlingReportsResponseBody

#### 📝 Description

**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getidlingevents) instead. The endpoint will continue to function as documented.** Get all vehicle idling reports for the requested time duration. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Fuel & Energy** 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.

#### 🔌 Usage

```typescript await client.legacyApIs.getVehicleIdlingReports({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehicleIdlingReportsRequest`

**requestOptions:** `LegacyApIsClient.RequestOptions`

client.legacyApIs.getSafetyEvents({ ...params }) -> Samsara.SafetyEventsListResponse

#### 📝 Description

**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getsafetyeventsv2stream) instead. The endpoint will continue to function as documented.** Fetch safety events for the organization in a given time period. **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 Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.legacyApIs.getSafetyEvents({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetSafetyEventsRequest`

**requestOptions:** `LegacyApIsClient.RequestOptions`

client.legacyApIs.getSafetyActivityEventFeed({ ...params }) -> Samsara.SafetyEventsGetSafetyActivityEventFeedResponseBody

#### 📝 Description

**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getsafetyeventsv2stream) instead. The endpoint will continue to function as documented.** Get continuous safety events. The safety activity event feed offers a change-log for safety events. Use this endpoint to subscribe to safety event changes. See documentation below for all supported change-log types. | ActivityType | Description | | ----------- | ----------- | | CreateSafetyEventActivityType | a new safety event is processed by Samsara | | BehaviorLabelActivityType | a label is added or removed from a safety event | | CoachingStateActivityType | a safety event coaching state is updated | Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read 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.

#### 🔌 Usage

```typescript await client.legacyApIs.getSafetyActivityEventFeed(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetSafetyActivityEventFeedRequest`

**requestOptions:** `LegacyApIsClient.RequestOptions`

client.legacyApIs.getVehiclesDriverAssignments({ ...params }) -> Samsara.VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsResponseBody

#### 📝 Description

**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getdrivervehicleassignments) instead. The endpoint will continue to function as documented.** Get all driver assignments for the requested vehicles in the requested time range. The only type of assignment supported right now are assignments created through the driver app. 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.

#### 🔌 Usage

```typescript await client.legacyApIs.getVehiclesDriverAssignments(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehiclesDriverAssignmentsRequest`

**requestOptions:** `LegacyApIsClient.RequestOptions`

client.legacyApIs.v1GetVehicleHarshEvent({ ...params }) -> Samsara.V1VehicleHarshEventResponse

#### 📝 Description

**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getsafetyeventsv2stream) instead. The endpoint will continue to function as documented.** > 🚧 This endpoint is still on our legacy API. Fetch harsh event details for a vehicle. **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 Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.legacyApIs.v1GetVehicleHarshEvent({ vehicleId: 1000000, timestamp: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetVehicleHarshEventRequest`

**requestOptions:** `LegacyApIsClient.RequestOptions`

## Documents

client.documents.getDocumentTypes({ ...params }) -> Samsara.DocumentTypesGetDocumentTypesResponseBody

#### 📝 Description

Returns a list of the organization document types. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentTypesByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** 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.

#### 🔌 Usage

```typescript await client.documents.getDocumentTypes(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDocumentTypesRequest`

**requestOptions:** `DocumentsClient.RequestOptions`

client.documents.getDocuments({ ...params }) -> Samsara.DocumentsGetDocumentsResponseBody

#### 📝 Description

Get all documents for the given time range. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentsByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** 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.

#### 🔌 Usage

```typescript await client.documents.getDocuments({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDocumentsRequest`

**requestOptions:** `DocumentsClient.RequestOptions`

client.documents.postDocument({ ...params }) -> Samsara.DocumentsPostDocumentResponseBody

#### 📝 Description

Creates a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/createDriverDocument). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** 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.

#### 🔌 Usage

```typescript await client.documents.postDocument({ documentTypeId: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", driverId: "45646" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DocumentsPostDocumentRequestBody`

**requestOptions:** `DocumentsClient.RequestOptions`

client.documents.generateDocumentPdf({ ...params }) -> Samsara.DocumentPdfGenerationResponse

#### 📝 Description

Request creation of a document PDF. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.documents.generateDocumentPdf({ documentId: "6c8c0c01-206a-41a4-9d21-15b9978d04cb" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DocumentPdfGenerationRequest`

**requestOptions:** `DocumentsClient.RequestOptions`

client.documents.getDocumentPdf({ ...params }) -> Samsara.DocumentPdfQueryResponse

#### 📝 Description

Returns generation job status and download URL for a PDF. **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 Documents** under the Driver Workflow category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.documents.getDocumentPdf({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDocumentPdfRequest`

**requestOptions:** `DocumentsClient.RequestOptions`

client.documents.getDocument({ ...params }) -> Samsara.DocumentsGetDocumentResponseBody

#### 📝 Description

Returns a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentByIdAndDriverId). Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** 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.

#### 🔌 Usage

```typescript await client.documents.getDocument({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDocumentRequest`

**requestOptions:** `DocumentsClient.RequestOptions`

client.documents.deleteDocument({ ...params }) -> void

#### 📝 Description

Deletes a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/deleteDriverDocumentByIdAndDriverId). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** 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.

#### 🔌 Usage

```typescript await client.documents.deleteDocument({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteDocumentRequest`

**requestOptions:** `DocumentsClient.RequestOptions`

## DriverVehicleAssignments

client.driverVehicleAssignments.getDriverVehicleAssignments({ ...params }) -> Samsara.DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsResponseBody

#### 📝 Description

Get all driver-vehicle assignments for the requested drivers or vehicles in the requested time range. To fetch driver-vehicle assignments out of the vehicle trips' time ranges, assignmentType needs to be specified. Note: this endpoint replaces past endpoints to fetch assignments by driver or by vehicle. Visit [this migration guide](https://developers.samsara.com/docs/migrating-from-driver-vehicle-assignment-or-vehicle-driver-assignment-endpoints) for more information. 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.

#### 🔌 Usage

```typescript await client.driverVehicleAssignments.getDriverVehicleAssignments({ filterBy: "drivers" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriverVehicleAssignmentsRequest`

**requestOptions:** `DriverVehicleAssignmentsClient.RequestOptions`

client.driverVehicleAssignments.createDriverVehicleAssignment({ ...params }) -> Samsara.DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentResponseBody

#### 📝 Description

Assign vehicle drive-time to a driver via API. For a step-by-step instruction on how to leverage this endpoint, see [this guide](https://developers.samsara.com/docs/creating-driver-vehicle-assignments) 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.

#### 🔌 Usage

```typescript await client.driverVehicleAssignments.createDriverVehicleAssignment({ driverId: "494123", vehicleId: "281474978683353" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody`

**requestOptions:** `DriverVehicleAssignmentsClient.RequestOptions`

client.driverVehicleAssignments.deleteDriverVehicleAssignments({ ...params }) -> void

#### 📝 Description

Delete driver assignments that were created using the `POST fleet/driver-vehicle-assignments` endpoint for the requested vehicle in the requested time range. 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.

#### 🔌 Usage

```typescript await client.driverVehicleAssignments.deleteDriverVehicleAssignments({ vehicleId: "281474978683353" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody`

**requestOptions:** `DriverVehicleAssignmentsClient.RequestOptions`

client.driverVehicleAssignments.updateDriverVehicleAssignment({ ...params }) -> Samsara.DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentResponseBody

#### 📝 Description

Update driver assignments that were created using the `POST fleet/driver-vehicle-assignments`. Vehicle Id, Driver Id, and Start Time must match an existing 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.

#### 🔌 Usage

```typescript await client.driverVehicleAssignments.updateDriverVehicleAssignment({ driverId: "494123", startTime: "2019-06-13T19:08:25Z", vehicleId: "281474978683353" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody`

**requestOptions:** `DriverVehicleAssignmentsClient.RequestOptions`

## Drivers

client.drivers.list({ ...params }) -> core.Page<Samsara.Driver, Samsara.ListDriversResponse>

#### 📝 Description

Get all drivers in organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Drivers** under the Drivers category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript const pageableResponse = await client.drivers.list(); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.drivers.list(); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```

#### ⚙️ Parameters

**request:** `Samsara.ListDriversRequest`

**requestOptions:** `DriversClient.RequestOptions`

client.drivers.create({ ...params }) -> Samsara.DriverResponse

#### 📝 Description

Add a driver to the organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Drivers** under the Drivers category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.drivers.create({ name: "Susan Jones", password: "aSecurePassword1234", username: "SusanJones" }); ```

#### ⚙️ Parameters

**request:** `Samsara.CreateDriverRequest`

**requestOptions:** `DriversClient.RequestOptions`

client.drivers.postDriverRemoteSignout({ ...params }) -> Samsara.DriverRemoteSignoutPostDriverRemoteSignoutResponseBody

#### 📝 Description

Sign out a driver from the Samsara Driver App To access this endpoint, your organization must have the Samsara Platform Premier license. Note: Sign out requests made while a logged-in driver does not have internet connection will not log the driver out. A success response will still be provided and the driver will be logged out once they have internet connection. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Driver Remote Signout** under the Drivers category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

#### 🔌 Usage

```typescript await client.drivers.postDriverRemoteSignout({ driverId: "12434" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DriverRemoteSignoutPostDriverRemoteSignoutRequestBody`

**requestOptions:** `DriversClient.RequestOptions`

client.drivers.get({ ...params }) -> Samsara.DriverResponse

#### 📝 Description

Get information about a driver. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Drivers** under the Drivers category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.drivers.get({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriversRequest`

**requestOptions:** `DriversClient.RequestOptions`

client.drivers.delete({ ...params }) -> void

#### 🔌 Usage

```typescript await client.drivers.delete({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteDriversRequest`

**requestOptions:** `DriversClient.RequestOptions`

client.drivers.update({ ...params }) -> Samsara.DriverResponse

#### 📝 Description

Update a specific driver's information. This can also be used to activate or de-activate a given driver by setting the driverActivationStatus field. If the driverActivationStatus field is 'deactivated' then the user can also specify the deactivatedAtTime. The deactivatedAtTime cannot be more than 6 months in the past and must not come before the dirver's latest active HOS log. It will be considered an error if deactivatedAtTime is provided with a driverActivationStatus of active. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Drivers** under the Drivers category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.drivers.update({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.UpdateDriverRequest`

**requestOptions:** `DriversClient.RequestOptions`

## AuthTokenForDriver

client.authTokenForDriver.authToken({ ...params }) -> Samsara.AuthTokenAuthTokenResponseBody

#### 📝 Description

Creates a short-lived auth token a driver can use to login. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Driver Auth Token** under the Drivers category when creating or editing an API token. Learn More. **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.

#### 🔌 Usage

```typescript await client.authTokenForDriver.authToken({ code: "dp[gZc1wAigz4uGa0Hh" }); ```

#### ⚙️ Parameters

**request:** `Samsara.AuthTokenAuthTokenRequestBody`

**requestOptions:** `AuthTokenForDriverClient.RequestOptions`

## Tachograph (EU Only)

client.tachographEuOnly.getDriverTachographActivity({ ...params }) -> Samsara.DriverTachographActivityResponse

#### 📝 Description

Returns all known tachograph activity for all specified drivers in the time range. **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 Tachograph (EU)** under the Compliance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.tachographEuOnly.getDriverTachographActivity({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriverTachographActivityRequest`

**requestOptions:** `TachographEuOnlyClient.RequestOptions`

client.tachographEuOnly.getDriverTachographFiles({ ...params }) -> Samsara.TachographDriverFilesResponse

#### 📝 Description

Returns all known tachograph files for all specified drivers in the time range. 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 Tachograph (EU)** under the Compliance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.tachographEuOnly.getDriverTachographFiles({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriverTachographFilesRequest`

**requestOptions:** `TachographEuOnlyClient.RequestOptions`

client.tachographEuOnly.getVehicleTachographFiles({ ...params }) -> Samsara.TachographVehicleFilesResponse

#### 📝 Description

Returns all known tachograph files for all specified vehicles in the time range. Rate limit: 150 requests/sec (learn more about rate limits here). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Tachograph (EU)** under the Compliance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.tachographEuOnly.getVehicleTachographFiles({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehicleTachographFilesRequest`

**requestOptions:** `TachographEuOnlyClient.RequestOptions`

## Equipment

client.equipment.listEquipment({ ...params }) -> Samsara.EquipmentListResponse

#### 📝 Description

Returns a list of all equipment in an organization.

#### 🔌 Usage

```typescript await client.equipment.listEquipment(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListEquipmentRequest`

**requestOptions:** `EquipmentClient.RequestOptions`

client.equipment.getEquipmentLocations({ ...params }) -> Samsara.EquipmentLocationsResponse

#### 📝 Description

Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.equipment.getEquipmentLocations(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetEquipmentLocationsRequest`

**requestOptions:** `EquipmentClient.RequestOptions`

client.equipment.getEquipmentLocationsFeed({ ...params }) -> Samsara.EquipmentLocationsListResponse

#### 📝 Description

Follow a continuous feed of all equipment locations. Your first call to this endpoint will provide you with the most recent location for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment location updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. We'd suggest waiting a minimum of 5 seconds before requesting updates. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.equipment.getEquipmentLocationsFeed(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetEquipmentLocationsFeedRequest`

**requestOptions:** `EquipmentClient.RequestOptions`

client.equipment.getEquipmentLocationsHistory({ ...params }) -> Samsara.EquipmentLocationsListResponse

#### 📝 Description

Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.equipment.getEquipmentLocationsHistory({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetEquipmentLocationsHistoryRequest`

**requestOptions:** `EquipmentClient.RequestOptions`

client.equipment.getEquipmentStats({ ...params }) -> Samsara.EquipmentStatsResponse

#### 📝 Description

Returns the last known stats for all equipment. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.equipment.getEquipmentStats(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetEquipmentStatsRequest`

**requestOptions:** `EquipmentClient.RequestOptions`

client.equipment.getEquipmentStatsFeed({ ...params }) -> Samsara.EquipmentStatsListResponse

#### 📝 Description

Follow a continuous feed of all equipment stats. Your first call to this endpoint will provide you with the most recent stats for each unit of equipment and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment stats updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. Each stat type has a different refresh rate, but in general we'd suggest waiting a minimum of 5 seconds before requesting updates. Rate limit: 150 requests/sec (learn more about rate limits here). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.equipment.getEquipmentStatsFeed(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetEquipmentStatsFeedRequest`

**requestOptions:** `EquipmentClient.RequestOptions`

client.equipment.getEquipmentStatsHistory({ ...params }) -> Samsara.EquipmentStatsListResponse

#### 📝 Description

Returns historical equipment status during the given time range. This can be optionally filtered by tags or specific equipment IDs. Rate limit: 150 requests/sec (learn more about rate limits here). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.equipment.getEquipmentStatsHistory({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetEquipmentStatsHistoryRequest`

**requestOptions:** `EquipmentClient.RequestOptions`

client.equipment.getEquipment({ ...params }) -> Samsara.EquipmentResponse

#### 📝 Description

Retrieves the unit of equipment with the given Samsara ID. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.equipment.getEquipment({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetEquipmentRequest`

**requestOptions:** `EquipmentClient.RequestOptions`

## Hours of Service

client.hoursOfService.getHosClocks({ ...params }) -> Samsara.HosClocksResponse

#### 📝 Description

Get the current HOS status for all drivers. Note that this includes inactive as well as active drivers. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getFleetHosLogsSummary). **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 ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.hoursOfService.getHosClocks(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetHosClocksRequest`

**requestOptions:** `HoursOfServiceClient.RequestOptions`

client.hoursOfService.getHosDailyLogs({ ...params }) -> Samsara.HosDailyLogsGetHosDailyLogsResponseBody

#### 📝 Description

Get summarized daily Hours of Service charts for the specified drivers. The time range for a log is defined by the `driver`'s `eldDayStartHour`. This value is configurable per driver. The `startDate` and `endDate` parameters indicate the date range you'd like to retrieve daily logs for. A daily log will be returned if its `startTime` is on any of the days within in this date range (inclusive of `startDate` and `endDate`). **Note:** If data is still being uploaded from the Samsara Driver App, it may not be completely reflected in the response from this endpoint. The best practice is to wait a couple of days before querying this endpoint to make sure that all data from the Samsara Driver App has been uploaded. If you are using the legacy version of this endpoint and looking for its documentation, you can find it [here](https://www.samsara.com/api-legacy#operation/getFleetDriversHosDailyLogs). 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.

#### 🔌 Usage

```typescript await client.hoursOfService.getHosDailyLogs(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetHosDailyLogsRequest`

**requestOptions:** `HoursOfServiceClient.RequestOptions`

client.hoursOfService.getHosLogs({ ...params }) -> Samsara.HosLogsResponse

#### 📝 Description

Returns HOS logs between a given `startTime` and `endTime`. The logs can be further filtered using tags or by providing a list of driver IDs (including external IDs). The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getFleetHosLogs). **Note:** If data is still being uploaded from the Samsara Driver App, it may not be completely reflected in the response from this endpoint. The best practice is to wait a couple of days before querying this endpoint to make sure that all data from the Samsara Driver App has been uploaded. Rate limit: 5 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 ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.hoursOfService.getHosLogs(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetHosLogsRequest`

**requestOptions:** `HoursOfServiceClient.RequestOptions`

client.hoursOfService.getHosViolations({ ...params }) -> Samsara.HosViolationsGetHosViolationsResponseBody

#### 📝 Description

Get active Hours of Service violations for the specified drivers. The day object time range for a violation is defined by the `driver`'s `eldDayStartHour`. This value is configurable per driver. The `startTime` and `endTime` parameters indicate the datetime range you'd like to retrieve violations for. A violation will be returned if its `violationStartTime` falls within this datetime range (inclusive of `startTime` and `endTime`) **Note:** The following are all the violation types with a short explanation about what each of them means: `californiaMealbreakMissed` (Missed California Meal Break), `cycleHoursOn` (Cycle Limit), `cycleOffHoursAfterOnDutyHours` (Cycle 2 Limit), `dailyDrivingHours` (Daily Driving Limit), `dailyOffDutyDeferralAddToDay2Consecutive` (Daily Off-Duty Deferral: Add To Day2 Consecutive), `dailyOffDutyDeferralNotPartMandatory` (Daily Off-Duty Deferral: Not Part Of Mandatory), `dailyOffDutyDeferralTwoDayDrivingLimit` (Daily Off-Duty Deferral: 2 Day Driving Limit), `dailyOffDutyDeferralTwoDayOffDuty` (Daily Off-Duty Deferral: 2 Day Off Duty), `dailyOffDutyNonResetHours` (Daily Off-Duty Time: Non-Reset), `dailyOffDutyTotalHours` (Daily Off-Duty Time), `dailyOnDutyHours` (Daily On-Duty Limit), `mandatory24HoursOffDuty` (24 Hours of Off Duty required), `restbreakMissed` (Missed Rest Break), `shiftDrivingHours` (Shift Driving Limit), `shiftHours` (Shift Duty Limit), `shiftOnDutyHours` (Shift On-Duty Limit), `unsubmittedLogs` (Missing Driver Certification) 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.

#### 🔌 Usage

```typescript await client.hoursOfService.getHosViolations(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetHosViolationsRequest`

**requestOptions:** `HoursOfServiceClient.RequestOptions`

client.hoursOfService.setCurrentDutyStatus({ ...params }) -> void

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Set an individual driver’s current duty status to 'On Duty' or 'Off Duty'. To ensure compliance with the ELD Mandate, only authenticated drivers can make direct duty status changes on their own logbook. Any system external to the Samsara Driver App using this endpoint to trigger duty status changes must ensure that such changes are only triggered directly by the driver in question and that the driver has been properly authenticated. This endpoint should not be used to algorithmically trigger duty status changes nor should it be used by personnel besides the driver to trigger duty status changes on the driver’s behalf. Carriers and their drivers are ultimately responsible for maintaining accurate logs and should confirm that their use of the endpoint is compliant with the ELD Mandate. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write ELD Hours of Service (US)** under the Compliance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.hoursOfService.setCurrentDutyStatus({ driver_id: 1000000, duty_status: "ON_DUTY" }); ```

#### ⚙️ Parameters

**request:** `Samsara.InlineObject1`

**requestOptions:** `HoursOfServiceClient.RequestOptions`

client.hoursOfService.v1GetFleetHosAuthenticationLogs({ ...params }) -> Samsara.V1HosAuthenticationLogsResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get the HOS (hours of service) signin and signout logs for the specified driver. The response includes 4 fields that are now deprecated. **Note:** If data is still being uploaded from the Samsara Driver App, it may not be completely reflected in the response from this endpoint. The best practice is to wait a couple of days before querying this endpoint to make sure that all data from the Samsara Driver App has been uploaded. **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 ELD Hours of Service (US)** under the Compliance category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.hoursOfService.v1GetFleetHosAuthenticationLogs({ driverId: 1000000, startMs: 1000000, endMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetFleetHosAuthenticationLogsRequest`

**requestOptions:** `HoursOfServiceClient.RequestOptions`

## Ifta

client.ifta.getIftaJurisdictionReports({ ...params }) -> Samsara.IftaGetIftaJurisdictionReportsResponseBody

#### 📝 Description

Get all jurisdiction IFTA reports for the requested time duration. Data is returned in your organization's defined timezone. **Note:** The most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (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.

#### 🔌 Usage

```typescript await client.ifta.getIftaJurisdictionReports({ year: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetIftaJurisdictionReportsRequest`

**requestOptions:** `IftaClient.RequestOptions`

client.ifta.getIftaVehicleReports({ ...params }) -> Samsara.IftaGetIftaVehicleReportsResponseBody

#### 📝 Description

Get all vehicle IFTA reports for the requested time duration. Data is returned in your organization's defined timezone. **Note:** The most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (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.

#### 🔌 Usage

```typescript await client.ifta.getIftaVehicleReports({ year: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetIftaVehicleReportsRequest`

**requestOptions:** `IftaClient.RequestOptions`

client.ifta.createIftaDetailJob({ ...params }) -> Samsara.IftaCreateIftaDetailJobResponseBody

#### 📝 Description

Create a job to generate csv files of IFTA mileage segments. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write IFTA (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.

#### 🔌 Usage

```typescript await client.ifta.createIftaDetailJob({ endHour: "2019-06-13T19:00:00Z", startHour: "2019-06-13T19:00:00Z" }); ```

#### ⚙️ Parameters

**request:** `Samsara.IftaCreateIftaDetailJobRequestBody`

**requestOptions:** `IftaClient.RequestOptions`

client.ifta.getIftaDetailJob({ ...params }) -> Samsara.IftaGetIftaDetailJobResponseBody

#### 📝 Description

Get information about an existing IFTA detail job. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read IFTA (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.

#### 🔌 Usage

```typescript await client.ifta.getIftaDetailJob({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetIftaDetailJobRequest`

**requestOptions:** `IftaClient.RequestOptions`

## Routes

client.routes.fetchRoutes({ ...params }) -> Samsara.RoutesFetchRoutesResponseBody

#### 📝 Description

Returns multiple routes. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/fetchAllDispatchRoutes). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. **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.

#### 🔌 Usage

```typescript await client.routes.fetchRoutes({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.FetchRoutesRequest`

**requestOptions:** `RoutesClient.RequestOptions`

client.routes.createRoute({ ...params }) -> Samsara.RoutesCreateRouteResponseBody

#### 📝 Description

Create a route. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/createDispatchRoute). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. **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.

#### 🔌 Usage

```typescript await client.routes.createRoute({ name: "Bid 123", stops: [{}] }); ```

#### ⚙️ Parameters

**request:** `Samsara.RoutesCreateRouteRequestBody`

**requestOptions:** `RoutesClient.RequestOptions`

client.routes.getRoutesFeed({ ...params }) -> Samsara.RoutesGetRoutesFeedResponseBody

#### 📝 Description

Subscribes to a feed of immutable, append-only updates for routes. The initial request to this feed endpoint returns a cursor, which can be used on the next request to fetch updated routes that have had state changes since that request. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/fetchAllRouteJobUpdates). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. **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.

#### 🔌 Usage

```typescript await client.routes.getRoutesFeed(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetRoutesFeedRequest`

**requestOptions:** `RoutesClient.RequestOptions`

client.routes.fetchRoute({ ...params }) -> Samsara.RoutesFetchRouteResponseBody

#### 📝 Description

Returns a single route. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDispatchRouteById). Rate limit: 25 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.

#### 🔌 Usage

```typescript await client.routes.fetchRoute({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.FetchRouteRequest`

**requestOptions:** `RoutesClient.RequestOptions`

client.routes.deleteRoute({ ...params }) -> void

#### 📝 Description

Delete a dispatch route and its associated stops. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. **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.

#### 🔌 Usage

```typescript await client.routes.deleteRoute({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteRouteRequest`

**requestOptions:** `RoutesClient.RequestOptions`

client.routes.patchRoute({ ...params }) -> Samsara.RoutesPatchRouteResponseBody

#### 📝 Description

Update a route. **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. The legacy version of this endpoint (which uses PUT instead of PATCH) can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/updateDispatchRouteById). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. **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.

#### 🔌 Usage

```typescript await client.routes.patchRoute({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.RoutesPatchRouteRequestBody`

**requestOptions:** `RoutesClient.RequestOptions`

client.routes.listHubPlanRoutes({ ...params }) -> Samsara.HubPlanRoutesListHubPlanRoutesResponseBody

#### 📝 Description

Retrieve routes for a specific plan. 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.

#### 🔌 Usage

```typescript await client.routes.listHubPlanRoutes({ planId: "planId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListHubPlanRoutesRequest`

**requestOptions:** `RoutesClient.RequestOptions`

client.routes.v1DeleteDispatchRouteById({ ...params }) -> void

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Delete a dispatch route and its associated jobs. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.routes.v1DeleteDispatchRouteById({ route_id_or_external_id: "route_id_or_external_id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.InlineObject`

**requestOptions:** `RoutesClient.RequestOptions`

## Settings

client.settings.getComplianceSettings() -> Samsara.SettingsGetComplianceSettingsResponseBody

#### 📝 Description

Get organization's compliance settings, including carrier name, office address, and DOT number 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.

#### 🔌 Usage

```typescript await client.settings.getComplianceSettings(); ```

#### ⚙️ Parameters

**requestOptions:** `SettingsClient.RequestOptions`

client.settings.patchComplianceSettings({ ...params }) -> Samsara.SettingsPatchComplianceSettingsResponseBody

#### 📝 Description

Update organization's compliance settings, including carrier name, office address, and DOT number Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write 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.

#### 🔌 Usage

```typescript await client.settings.patchComplianceSettings(); ```

#### ⚙️ Parameters

**request:** `Samsara.SettingsPatchComplianceSettingsRequestBody`

**requestOptions:** `SettingsClient.RequestOptions`

client.settings.getDriverAppSettings() -> Samsara.SettingsGetDriverAppSettingsResponseBody

#### 📝 Description

Get driver app settings. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read 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.

#### 🔌 Usage

```typescript await client.settings.getDriverAppSettings(); ```

#### ⚙️ Parameters

**requestOptions:** `SettingsClient.RequestOptions`

client.settings.patchDriverAppSettings({ ...params }) -> Samsara.SettingsPatchDriverAppSettingsResponseBody

#### 📝 Description

Update driver app settings. Rate limit: 100 requests/min (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.

#### 🔌 Usage

```typescript await client.settings.patchDriverAppSettings(); ```

#### ⚙️ Parameters

**request:** `Samsara.SettingsPatchDriverAppSettingsRequestBody`

**requestOptions:** `SettingsClient.RequestOptions`

client.settings.getSafetySettings() -> Samsara.SafetySettingsGetSafetySettingsResponseBody

#### 📝 Description

Get safety settings Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read 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.

#### 🔌 Usage

```typescript await client.settings.getSafetySettings(); ```

#### ⚙️ Parameters

**requestOptions:** `SettingsClient.RequestOptions`

## Trailers

client.trailers.listTrailers({ ...params }) -> Samsara.TrailersListTrailersResponseBody

#### 📝 Description

List all trailers. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Trailers** under the Trailers 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.

#### 🔌 Usage

```typescript await client.trailers.listTrailers(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListTrailersRequest`

**requestOptions:** `TrailersClient.RequestOptions`

client.trailers.createTrailer({ ...params }) -> Samsara.TrailersCreateTrailerResponseBody

#### 📝 Description

Creates a new trailer asset. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Trailers** under the Trailers 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.

#### 🔌 Usage

```typescript await client.trailers.createTrailer({ name: "Trailer-123" }); ```

#### ⚙️ Parameters

**request:** `Samsara.TrailersCreateTrailerRequestBody`

**requestOptions:** `TrailersClient.RequestOptions`

client.trailers.getTrailerStatsSnapshot({ ...params }) -> Samsara.TrailerStatsGetTrailerStatsSnapshotResponseBody

#### 📝 Description

Returns the last known stats of all trailers at the given `time`. If no `time` is specified, the current time is used. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Trailer Statistics** under the Trailers 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.

#### 🔌 Usage

```typescript await client.trailers.getTrailerStatsSnapshot({ types: "types" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTrailerStatsSnapshotRequest`

**requestOptions:** `TrailersClient.RequestOptions`

client.trailers.getTrailerStatsFeed({ ...params }) -> Samsara.TrailerStatsGetTrailerStatsFeedResponseBody

#### 📝 Description

Follow a feed of trailer stats. The first call to this endpoint will provide the most recent stats for each trailer and an `endCursor`. Providing the `endCursor` value to the `after` query parameter will fetch all updates since the previous API call. If `hasNextPage` is false, no new data is immediately available. Please wait a minimum of 5 seconds before making a subsequent request. Each page includes every trailer in the current device page, even when a requested stat type has no datapoints. For example, a trailer without recent GPS data is returned with an empty `gps` array rather than being omitted from the response. An empty stat array typically indicates the gateway has not reported that stat recently due to an unhealthy or low-battery gateway, or because the trailer has been inactive. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Trailer Statistics** under the Trailers 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.

#### 🔌 Usage

```typescript await client.trailers.getTrailerStatsFeed({ types: "types" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTrailerStatsFeedRequest`

**requestOptions:** `TrailersClient.RequestOptions`

client.trailers.getTrailerStatsHistory({ ...params }) -> Samsara.TrailerStatsGetTrailerStatsHistoryResponseBody

#### 📝 Description

Returns trailer stats during the given time range for all trailers. This can be optionally filtered by tags or specific trailer IDs. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Trailer Statistics** under the Trailers 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.

#### 🔌 Usage

```typescript await client.trailers.getTrailerStatsHistory({ startTime: "startTime", endTime: "endTime", types: "types" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTrailerStatsHistoryRequest`

**requestOptions:** `TrailersClient.RequestOptions`

client.trailers.getTrailer({ ...params }) -> Samsara.TrailersGetTrailerResponseBody

#### 📝 Description

Retrieve a trailer with given ID. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Trailers** under the Trailers 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.

#### 🔌 Usage

```typescript await client.trailers.getTrailer({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTrailerRequest`

**requestOptions:** `TrailersClient.RequestOptions`

client.trailers.deleteTrailer({ ...params }) -> void

#### 📝 Description

Delete a trailer with the given ID. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Trailers** under the Trailers 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.

#### 🔌 Usage

```typescript await client.trailers.deleteTrailer({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteTrailerRequest`

**requestOptions:** `TrailersClient.RequestOptions`

client.trailers.updateTrailer({ ...params }) -> Samsara.TrailersUpdateTrailerResponseBody

#### 📝 Description

Update a trailer. **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 Trailers** under the Trailers 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.

#### 🔌 Usage

```typescript await client.trailers.updateTrailer({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.TrailersUpdateTrailerRequestBody`

**requestOptions:** `TrailersClient.RequestOptions`

## Vehicles

client.vehicles.list({ ...params }) -> core.Page<Samsara.VehicleResponseObjectResponseBody, Samsara.VehiclesListVehiclesResponseBody>

#### 📝 Description

Returns a list of all vehicles. Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Vehicles** 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.

#### 🔌 Usage

```typescript const pageableResponse = await client.vehicles.list(); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.vehicles.list(); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; ```

#### ⚙️ Parameters

**request:** `Samsara.ListVehiclesRequest`

**requestOptions:** `VehiclesClient.RequestOptions`

client.vehicles.get({ ...params }) -> Samsara.VehicleResponse

#### 📝 Description

Get information about a specific vehicle. **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 Vehicles** under the Vehicles category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.vehicles.get({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehiclesRequest`

**requestOptions:** `VehiclesClient.RequestOptions`

client.vehicles.update({ ...params }) -> Samsara.VehicleResponse

#### 📝 Description

Updates the given Vehicle object. **Note:** Vehicle objects are automatically created when Samsara Vehicle Gateways are installed. You cannot create a Vehicle object via API. You are able to *update* many of the fields of a Vehicle. **Note**: There are no required fields in the request body, and you only need to provide the fields you wish to update. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Vehicles** under the Vehicles category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.vehicles.update({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.UpdateVehicleRequest`

**requestOptions:** `VehiclesClient.RequestOptions`

## Vehicle Locations

client.vehicleLocations.getVehicleLocations({ ...params }) -> Samsara.VehicleLocationsResponse

#### 📝 Description

***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestats) instead.*** Returns the last known location of all vehicles at the given `time`. If no `time` is specified, the current time is used. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.vehicleLocations.getVehicleLocations(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehicleLocationsRequest`

**requestOptions:** `VehicleLocationsClient.RequestOptions`

client.vehicleLocations.getVehicleLocationsFeed({ ...params }) -> Samsara.VehicleLocationsListResponse

#### 📝 Description

***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatsfeed) instead.*** Follow a continuous feed of all vehicle locations from Samsara Vehicle Gateways. Your first call to this endpoint will provide you with the most recent location for each vehicle and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to the `after` parameter of this endpoint to get location updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. We'd suggest waiting a minimum of 5 seconds before requesting updates. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.vehicleLocations.getVehicleLocationsFeed(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehicleLocationsFeedRequest`

**requestOptions:** `VehicleLocationsClient.RequestOptions`

client.vehicleLocations.getVehicleLocationsHistory({ ...params }) -> Samsara.VehicleLocationsListResponse

#### 📝 Description

***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatshistory) instead.*** Returns all known vehicle locations during the given time range. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Vehicle Locations. **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 Vehicle Statistics** under the Vehicle category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.vehicleLocations.getVehicleLocationsHistory({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehicleLocationsHistoryRequest`

**requestOptions:** `VehicleLocationsClient.RequestOptions`

## Vehicle Stats

client.vehicleStats.getVehicleStats({ ...params }) -> Samsara.VehicleStatsResponse

#### 📝 Description

Returns the last known stats of all vehicles at the given `time`. If no `time` is specified, the current time is used. Related guide: Telematics. **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 Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.vehicleStats.getVehicleStats(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehicleStatsRequest`

**requestOptions:** `VehicleStatsClient.RequestOptions`

client.vehicleStats.getVehicleStatsFeed({ ...params }) -> Samsara.VehicleStatsListResponse

#### 📝 Description

Follow a feed of vehicle stats. Your first call to this endpoint will provide you with the most recent stats for each vehicle and an `endCursor`. You can the provide the `endCursor` value to the `after` query parameter to get all updates since the last call you made. If `hasNextPage` is `false`, no new data is immediately available. You should wait a minimum of 5 seconds making a subsequent request. Related guide: Telematics. **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 Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.vehicleStats.getVehicleStatsFeed(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehicleStatsFeedRequest`

**requestOptions:** `VehicleStatsClient.RequestOptions`

client.vehicleStats.getVehicleStatsHistory({ ...params }) -> Samsara.VehicleStatsListResponse

#### 📝 Description

Returns vehicle stats during the given time range for all vehicles. This can be optionally filtered by tags or specific vehicle IDs. Related guide: Telematics. **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 Vehicle Statistics** under the Vehicles category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.vehicleStats.getVehicleStatsHistory({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehicleStatsHistoryRequest`

**requestOptions:** `VehicleStatsClient.RequestOptions`

## Forms

client.forms.getFormSubmissions({ ...params }) -> Samsara.FormSubmissionsGetFormSubmissionsResponseBody

#### 📝 Description

Returns all form submissions data for the specified list of IDs. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** under the Forms 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.

#### 🔌 Usage

```typescript await client.forms.getFormSubmissions(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFormSubmissionsRequest`

**requestOptions:** `FormsClient.RequestOptions`

client.forms.postFormSubmission({ ...params }) -> Samsara.FormSubmissionsPostFormSubmissionResponseBody

#### 📝 Description

Creates a form submission and assigns it to an individual worker. This endpoint can be used to create an empty or partially complete form submission and assign it to a worker. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Form Submissions** under the Forms 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.

#### 🔌 Usage

```typescript await client.forms.postFormSubmission({ formTemplate: { id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", revisionId: "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7" }, status: "notStarted" }); ```

#### ⚙️ Parameters

**request:** `Samsara.FormSubmissionsPostFormSubmissionRequestBody`

**requestOptions:** `FormsClient.RequestOptions`

client.forms.patchFormSubmission({ ...params }) -> Samsara.FormSubmissionsPatchFormSubmissionResponseBody

#### 📝 Description

Updates an instance of a form submission. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Form Submissions** under the Forms 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.

#### 🔌 Usage

```typescript await client.forms.patchFormSubmission({ id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac8", status: "notStarted" }); ```

#### ⚙️ Parameters

**request:** `Samsara.FormSubmissionsPatchFormSubmissionRequestBody`

**requestOptions:** `FormsClient.RequestOptions`

client.forms.getFormSubmissionsPdfExports({ ...params }) -> Samsara.FormSubmissionsGetFormSubmissionsPdfExportsResponseBody

#### 📝 Description

Returns a PDF export that has already been generated for a form submission. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** under the Forms 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.

#### 🔌 Usage

```typescript await client.forms.getFormSubmissionsPdfExports({ pdfId: "pdfId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFormSubmissionsPdfExportsRequest`

**requestOptions:** `FormsClient.RequestOptions`

client.forms.postFormSubmissionsPdfExports({ ...params }) -> Samsara.FormSubmissionsPostFormSubmissionsPdfExportsResponseBody

#### 📝 Description

Creates a PDF export for an existing form submission. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Form Submissions** under the Forms 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.

#### 🔌 Usage

```typescript await client.forms.postFormSubmissionsPdfExports({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.PostFormSubmissionsPdfExportsRequest`

**requestOptions:** `FormsClient.RequestOptions`

client.forms.getFormSubmissionsStream({ ...params }) -> Samsara.FormSubmissionsGetFormSubmissionsStreamResponseBody

#### 📝 Description

Returns all form submissions data that has 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, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** under the Forms 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.

#### 🔌 Usage

```typescript await client.forms.getFormSubmissionsStream({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFormSubmissionsStreamRequest`

**requestOptions:** `FormsClient.RequestOptions`

client.forms.getFormTemplates({ ...params }) -> Samsara.FormTemplatesGetFormTemplatesResponseBody

#### 📝 Description

Returns a list of the organization's form templates for the specified list of IDs. If no IDs are provided, all form templates for the organization will be returned. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** under the Forms 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.

#### 🔌 Usage

```typescript await client.forms.getFormTemplates(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFormTemplatesRequest`

**requestOptions:** `FormsClient.RequestOptions`

## Gateways

client.gateways.getGateways({ ...params }) -> Samsara.GatewaysGetGatewaysResponseBody

#### 📝 Description

List all gateways Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read 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.

#### 🔌 Usage

```typescript await client.gateways.getGateways(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetGatewaysRequest`

**requestOptions:** `GatewaysClient.RequestOptions`

client.gateways.postGateway({ ...params }) -> Samsara.GatewaysPostGatewayResponseBody

#### 📝 Description

Activate a new gateway. To activate a device and associate it with your organization, enter its serial number. Each device's serial number can also be found on its label or packaging, or from your order confirmation email. A Not Found error could mean that the serial was not found or it has already been activated 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.

#### 🔌 Usage

```typescript await client.gateways.postGateway({ serial: "GFRV-43N-VGX" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GatewaysPostGatewayRequestBody`

**requestOptions:** `GatewaysClient.RequestOptions`

client.gateways.deleteGateway({ ...params }) -> void

#### 📝 Description

Deactivate a gateway 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.

#### 🔌 Usage

```typescript await client.gateways.deleteGateway({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteGatewayRequest`

**requestOptions:** `GatewaysClient.RequestOptions`

## Hubs

client.hubs.listHubCapacities({ ...params }) -> Samsara.HubCapacitiesListHubCapacitiesResponseBody

#### 📝 Description

Retrieve capacity types for a specific hub. 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.

#### 🔌 Usage

```typescript await client.hubs.listHubCapacities({ hubId: "hubId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListHubCapacitiesRequest`

**requestOptions:** `HubsClient.RequestOptions`

client.hubs.listHubCustomProperties({ ...params }) -> Samsara.HubCustomPropertiesListHubCustomPropertiesResponseBody

#### 📝 Description

Retrieve custom properties for a specific hub. 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.

#### 🔌 Usage

```typescript await client.hubs.listHubCustomProperties({ hubId: "hubId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListHubCustomPropertiesRequest`

**requestOptions:** `HubsClient.RequestOptions`

client.hubs.updateHubLocation({ ...params }) -> Samsara.HubLocationsUpdateHubLocationResponseBody

#### 📝 Description

Update existing location by ID. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. **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.

#### 🔌 Usage

```typescript await client.hubs.updateHubLocation({ id: "id", data: { address: "123 Industrial Blvd, Los Angeles, CA 90210, US", customerLocationId: "LOC-123", driverInstructions: "sample instructions", isDepot: false, latitude: 34.0522, longitude: -118.2437, name: "Customer ABC Warehouse", plannerNotes: "sample note", serviceTimeSeconds: 1800, serviceWindows: [{ daysOfWeek: ["monday", "tuesday", "wednesday", "thursday", "friday"], endTime: "17:00:00", startTime: "08:00:00" }], skillsRequired: ["650e8400-e29b-41d4-a716-446655440001"] } }); ```

#### ⚙️ Parameters

**request:** `Samsara.HubLocationsUpdateHubLocationRequestBody`

**requestOptions:** `HubsClient.RequestOptions`

client.hubs.listHubLocations({ ...params }) -> Samsara.HubLocationsListHubLocationsResponseBody

#### 📝 Description

Retrieve locations for a specific hub. 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.

#### 🔌 Usage

```typescript await client.hubs.listHubLocations({ hubId: "hubId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListHubLocationsRequest`

**requestOptions:** `HubsClient.RequestOptions`

client.hubs.createHubLocations({ ...params }) -> Samsara.HubLocationsCreateHubLocationsResponseBody

#### 📝 Description

Create new locations. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. **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.

#### 🔌 Usage

```typescript await client.hubs.createHubLocations({ data: [{ address: "123 Industrial Blvd, Los Angeles, CA 90210, US", customerLocationId: "LOC-123", driverInstructions: "sample instructions", hubId: "550e8400-e29b-41d4-a716-446655440000", isDepot: false, latitude: 34.0522, longitude: -118.2437, name: "Customer ABC Warehouse", plannerNotes: "sample note", serviceTimeSeconds: 1800, serviceWindows: [{ daysOfWeek: ["monday", "tuesday", "wednesday", "thursday", "friday"], endTime: "17:00:00", startTime: "08:00:00" }], skillsRequired: ["650e8400-e29b-41d4-a716-446655440001"] }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.HubLocationsCreateHubLocationsRequestBody`

**requestOptions:** `HubsClient.RequestOptions`

client.hubs.listHubSkills({ ...params }) -> Samsara.HubSkillsListHubSkillsResponseBody

#### 📝 Description

Retrieve skills for a specific hub. 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.

#### 🔌 Usage

```typescript await client.hubs.listHubSkills({ hubId: "hubId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListHubSkillsRequest`

**requestOptions:** `HubsClient.RequestOptions`

client.hubs.listHubs({ ...params }) -> Samsara.HubsListHubsResponseBody

#### 📝 Description

Retrieve all hubs (planners) in the organization. This endpoint supports pagination and filtering based on hub IDs and update times. 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.

#### 🔌 Usage

```typescript await client.hubs.listHubs(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListHubsRequest`

**requestOptions:** `HubsClient.RequestOptions`

## Plans

client.plans.createHubPlan({ ...params }) -> Samsara.HubPlansCreateHubPlanResponseBody

#### 📝 Description

Create a new plan. 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.

#### 🔌 Usage

```typescript await client.plans.createHubPlan({ hubId: "550e8400-e29b-41d4-a716-446655440000", name: "Weekly Plan - Week 15" }); ```

#### ⚙️ Parameters

**request:** `Samsara.HubPlansCreateHubPlanRequestBody`

**requestOptions:** `PlansClient.RequestOptions`

client.plans.createPlanOrders({ ...params }) -> Samsara.PlanOrdersCreatePlanOrdersResponseBody

#### 📝 Description

Create one or more orders (bulk upsert). Pass an array of order objects; any object whose customerOrderId already exists will be updated, otherwise a new order is created. Functions can return JSON arrays in this Order POST format. Orders are initially created at the plan level but will migrate to hub-level entities, with planId becoming optional in future versions. 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.

#### 🔌 Usage

```typescript await client.plans.createPlanOrders({ data: [{ customerOrderId: "ORDER-2024-001", hubId: "550e8400-e29b-41d4-a716-446655440000", planId: "650e8400-e29b-41d4-a716-446655440023" }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.PlanOrdersCreatePlanOrdersRequestBody`

**requestOptions:** `PlansClient.RequestOptions`

client.plans.listHubPlans({ ...params }) -> Samsara.HubPlansListHubPlansResponseBody

#### 📝 Description

Retrieve all plans for a specific hub. 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.

#### 🔌 Usage

```typescript await client.plans.listHubPlans({ hubId: "hubId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ListHubPlansRequest`

**requestOptions:** `PlansClient.RequestOptions`

## Idling

client.idling.getIdlingEvents({ ...params }) -> Samsara.AdvancedIdlingGetIdlingEventsResponseBody

#### 📝 Description

Get idling events for the requested time duration. **Note:** The data from this endpoint comes from the new Advanced Idling Report, which provides additional data fields for each idling event such as air temperature, geofence, PTO state and minimum idle time. This endpoint includes data from January 1, 2024. If you require additional historical data, you can access it via the [vehicle idling reports API](https://developers.samsara.com/reference/getvehicleidlingreports). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Idling** 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.

#### 🔌 Usage

```typescript await client.idling.getIdlingEvents({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetIdlingEventsRequest`

**requestOptions:** `IdlingClient.RequestOptions`

## Industrial

client.industrial.getIndustrialAssets({ ...params }) -> Samsara.ListIndustrialAssetsResponse

#### 📝 Description

List all assets in the organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.getIndustrialAssets(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetIndustrialAssetsRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.createIndustrialAsset({ ...params }) -> Samsara.InlineResponse200

#### 📝 Description

Create an asset with optional configuration parameters. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.createIndustrialAsset({ name: "name" }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetCreate`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.patchIndustrialAsset({ ...params }) -> Samsara.InlineResponse200

#### 📝 Description

Update an existing asset. Only the provided fields will be updated. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.patchIndustrialAsset({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetPatch`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.patchAssetDataOutputs({ ...params }) -> Samsara.AssetDataOutputsPatchAssetDataOutputsResponseBody

#### 📝 Description

Writes values to multiple data outputs on an asset simultaneously. Only the provided data outputs will be updated. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Equipment Statistics** 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.

#### 🔌 Usage

```typescript await client.industrial.patchAssetDataOutputs({ id: "id", values: { "key": "value" } }); ```

#### ⚙️ Parameters

**request:** `Samsara.AssetDataOutputsPatchAssetDataOutputsRequestBody`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.getDataInputs({ ...params }) -> Samsara.DataInputsTinyResponse

#### 📝 Description

Returns all data inputs, optionally filtered by tags or asset ids. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.getDataInputs(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDataInputsRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.getDataInputDataSnapshot({ ...params }) -> Samsara.DataInputSnapshotResponse

#### 📝 Description

Returns last known data points for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.getDataInputDataSnapshot(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDataInputDataSnapshotRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.getDataInputDataFeed({ ...params }) -> Samsara.DataInputListResponse

#### 📝 Description

Follow a continuous feed of all data input data points. Your first call to this endpoint will provide you with the most recent data points for each data input and a `pagination` object that contains an `endCursor`. You can provide the `endCursor` to the `after` parameter of this endpoint to get data point updates since that `endCursor`. If `hasNextPage` is `false`, no updates are readily available yet. We suggest waiting a minimum of 5 seconds before requesting updates. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.getDataInputDataFeed(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDataInputDataFeedRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.getDataInputDataHistory({ ...params }) -> Samsara.DataInputListResponse

#### 📝 Description

Returns all known data points during the given time range for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.getDataInputDataHistory({ startTime: "startTime", endTime: "endTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDataInputDataHistoryRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.v1GetCameras() -> Samsara.V1VisionCamerasResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch all cameras. **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 Industrial** under the Industrial category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.v1GetCameras(); ```

#### ⚙️ Parameters

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.v1GetVisionProgramsByCamera({ ...params }) -> Samsara.V1ProgramsForTheCameraResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch configured programs on the camera. **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 Industrial** under the Industrial category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.v1GetVisionProgramsByCamera({ camera_id: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetVisionProgramsByCameraRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.v1GetVisionLatestRunCamera({ ...params }) -> Samsara.V1VisionRunByCameraResponse

#### 📝 Description

Fetch the latest run for a camera or program by default. If startedAtMs is supplied, fetch the specific run that corresponds to that start time. **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 Industrial** under the Industrial category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.v1GetVisionLatestRunCamera({ camera_id: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetVisionLatestRunCameraRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.v1GetVisionRuns({ ...params }) -> Samsara.V1VisionRunsResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch runs. **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 Industrial** under the Industrial category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.v1GetVisionRuns({ durationMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetVisionRunsRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.getVisionRunsByCamera({ ...params }) -> Samsara.V1VisionRunsByCameraResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch runs by camera. **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 Industrial** under the Industrial category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.getVisionRunsByCamera({ camera_id: 1000000, durationMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVisionRunsByCameraRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.v1GetVisionRunsByCameraAndProgram({ ...params }) -> Samsara.V1VisionRunsByCameraAndProgramResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch runs by camera and program. **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 Industrial** under the Industrial category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.v1GetVisionRunsByCameraAndProgram({ camera_id: 1000000, program_id: 1000000, started_at_ms: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetVisionRunsByCameraAndProgramRequest`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.v1GetMachinesHistory({ ...params }) -> Samsara.V1MachineHistoryResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get historical data for machine objects. This method returns a set of historical data for all machines. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.v1GetMachinesHistory({ endMs: 1462881998034, startMs: 1462878398034 }); ```

#### ⚙️ Parameters

**request:** `Samsara.InlineObject3`

**requestOptions:** `IndustrialClient.RequestOptions`

client.industrial.v1GetMachines() -> Samsara.InlineResponse2008

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get machine objects. This method returns a list of the machine objects in the Samsara Cloud and information about them. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.v1GetMachines(); ```

#### ⚙️ Parameters

**requestOptions:** `IndustrialClient.RequestOptions`

## Issues

client.issues.getIssues({ ...params }) -> Samsara.IssuesGetIssuesResponseBody

#### 📝 Description

Returns all issues data for the specified IDs. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Issues** under the Forms 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.

#### 🔌 Usage

```typescript await client.issues.getIssues(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetIssuesRequest`

**requestOptions:** `IssuesClient.RequestOptions`

client.issues.postIssue({ ...params }) -> Samsara.IssuesPostIssueResponseBody

#### 📝 Description

Creates a new issue associated with an asset, with optional media attachments uploaded inline as base64. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Issues** under the Forms 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.

#### 🔌 Usage

```typescript await client.issues.postIssue({ asset: { id: "hertzAssetId:HZ-100423" }, title: "Front bumper scratch" }); ```

#### ⚙️ Parameters

**request:** `Samsara.IssuesPostIssueRequestBody`

**requestOptions:** `IssuesClient.RequestOptions`

client.issues.patchIssue({ ...params }) -> Samsara.IssuesPatchIssueResponseBody

#### 📝 Description

Updates an instance of an issue. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Issues** under the Forms 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.

#### 🔌 Usage

```typescript await client.issues.patchIssue({ id: "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7" }); ```

#### ⚙️ Parameters

**request:** `Samsara.IssuesPatchIssueRequestBody`

**requestOptions:** `IssuesClient.RequestOptions`

client.issues.getIssuesStream({ ...params }) -> Samsara.IssuesGetIssuesStreamResponseBody

#### 📝 Description

Returns all issues data that has 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, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Issues** under the Forms 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.

#### 🔌 Usage

```typescript await client.issues.getIssuesStream({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetIssuesStreamRequest`

**requestOptions:** `IssuesClient.RequestOptions`

## LiveSharingLinks

client.liveSharingLinks.getLiveSharingLinks({ ...params }) -> Samsara.LiveSharingLinksGetLiveSharingLinksResponseBody

#### 📝 Description

Returns all non-expired Live Sharing Links. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Live Sharing Links** 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.

#### 🔌 Usage

```typescript await client.liveSharingLinks.getLiveSharingLinks(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetLiveSharingLinksRequest`

**requestOptions:** `LiveSharingLinksClient.RequestOptions`

client.liveSharingLinks.createLiveSharingLink({ ...params }) -> Samsara.LiveSharingLinksCreateLiveSharingLinkResponseBody

#### 📝 Description

Create Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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.

#### 🔌 Usage

```typescript await client.liveSharingLinks.createLiveSharingLink({ name: "Example Live Sharing Link name", type: "assetsLocation" }); ```

#### ⚙️ Parameters

**request:** `Samsara.LiveSharingLinksCreateLiveSharingLinkRequestBody`

**requestOptions:** `LiveSharingLinksClient.RequestOptions`

client.liveSharingLinks.deleteLiveSharingLink({ ...params }) -> void

#### 📝 Description

Delete Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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.

#### 🔌 Usage

```typescript await client.liveSharingLinks.deleteLiveSharingLink({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteLiveSharingLinkRequest`

**requestOptions:** `LiveSharingLinksClient.RequestOptions`

client.liveSharingLinks.updateLiveSharingLink({ ...params }) -> Samsara.LiveSharingLinksUpdateLiveSharingLinkResponseBody

#### 📝 Description

Update Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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.

#### 🔌 Usage

```typescript await client.liveSharingLinks.updateLiveSharingLink({ id: "id", name: "Example Live Sharing Link name" }); ```

#### ⚙️ Parameters

**request:** `Samsara.LiveSharingLinksUpdateLiveSharingLinkRequestBody`

**requestOptions:** `LiveSharingLinksClient.RequestOptions`

## WorkOrders

client.workOrders.postInvoiceScan({ ...params }) -> Samsara.WorkOrdersPostInvoiceScanResponseBody

#### 📝 Description

Process an invoice scan to create or update a work order with AI-extracted data. Accepts base64 encoded invoice files (PDF, JPEG, PNG) up to 10MB. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write 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.

#### 🔌 Usage

```typescript await client.workOrders.postInvoiceScan({ file: { base64Content: "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8P...", contentType: "application/pdf" } }); ```

#### ⚙️ Parameters

**request:** `Samsara.WorkOrdersPostInvoiceScanRequestBody`

**requestOptions:** `WorkOrdersClient.RequestOptions`

client.workOrders.getServiceTasks({ ...params }) -> Samsara.WorkOrdersGetServiceTasksResponseBody

#### 📝 Description

Gets service tasks. 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.

#### 🔌 Usage

```typescript await client.workOrders.getServiceTasks(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetServiceTasksRequest`

**requestOptions:** `WorkOrdersClient.RequestOptions`

client.workOrders.getWorkOrders({ ...params }) -> Samsara.WorkOrdersGetWorkOrdersResponseBody

#### 📝 Description

Gets work orders. 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.

#### 🔌 Usage

```typescript await client.workOrders.getWorkOrders(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetWorkOrdersRequest`

**requestOptions:** `WorkOrdersClient.RequestOptions`

client.workOrders.postWorkOrders({ ...params }) -> Samsara.WorkOrdersPostWorkOrdersResponseBody

#### 📝 Description

Creates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write 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.

#### 🔌 Usage

```typescript await client.workOrders.postWorkOrders({ assetId: "12443" }); ```

#### ⚙️ Parameters

**request:** `Samsara.WorkOrdersPostWorkOrdersRequestBody`

**requestOptions:** `WorkOrdersClient.RequestOptions`

client.workOrders.deleteWorkOrders({ ...params }) -> void

#### 📝 Description

Deletes a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write 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.

#### 🔌 Usage

```typescript await client.workOrders.deleteWorkOrders({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteWorkOrdersRequest`

**requestOptions:** `WorkOrdersClient.RequestOptions`

client.workOrders.patchWorkOrders({ ...params }) -> Samsara.WorkOrdersPatchWorkOrdersResponseBody

#### 📝 Description

Updates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write 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.

#### 🔌 Usage

```typescript await client.workOrders.patchWorkOrders({ id: "5" }); ```

#### ⚙️ Parameters

**request:** `Samsara.WorkOrdersPatchWorkOrdersRequestBody`

**requestOptions:** `WorkOrdersClient.RequestOptions`

client.workOrders.streamWorkOrders({ ...params }) -> Samsara.WorkOrdersStreamWorkOrdersResponseBody

#### 📝 Description

Stream work orders. 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.

#### 🔌 Usage

```typescript await client.workOrders.streamWorkOrders({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.StreamWorkOrdersRequest`

**requestOptions:** `WorkOrdersClient.RequestOptions`

## Organization Info

client.organizationInfo.getOrganizationInfo() -> Samsara.OrganizationInfoResponse

#### 📝 Description

Get information about your organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Org Information** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.organizationInfo.getOrganizationInfo(); ```

#### ⚙️ Parameters

**requestOptions:** `OrganizationInfoClient.RequestOptions`

## Preview APIs

client.previewApIs.createDriverAuthToken({ ...params }) -> Samsara.DriversAuthTokenCreateDriverAuthTokenResponseBody

#### 📝 Description

Creates a short-lived auth token for a driver. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Driver Auth Token** under the Drivers category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

#### 🔌 Usage

```typescript await client.previewApIs.createDriverAuthToken({ code: "dp[gZc1wAigz4uGa0Hh" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DriversAuthTokenCreateDriverAuthTokenRequestBody`

**requestOptions:** `PreviewApIsClient.RequestOptions`

client.previewApIs.getOrders({ ...params }) -> Samsara.OrdersGetOrdersResponseBody

#### 📝 Description

Returns current canonical order state for up to 100 supplied order IDs. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

#### 🔌 Usage

```typescript await client.previewApIs.getOrders(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetOrdersRequest`

**requestOptions:** `PreviewApIsClient.RequestOptions`

client.previewApIs.deleteOrder({ ...params }) -> void

#### 📝 Description

Deletes one canonical order by Samsara UUID or external ID. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

#### 🔌 Usage

```typescript await client.previewApIs.deleteOrder({ orderId: "orderId" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteOrderRequest`

**requestOptions:** `PreviewApIsClient.RequestOptions`

client.previewApIs.postOrdersBatch({ ...params }) -> Samsara.OrdersPostOrdersBatchResponseBody

#### 📝 Description

Atomically creates or updates up to 250 canonical orders. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

#### 🔌 Usage

```typescript await client.previewApIs.postOrdersBatch({ data: [{}] }); ```

#### ⚙️ Parameters

**request:** `Samsara.OrdersPostOrdersBatchRequestBody`

**requestOptions:** `PreviewApIsClient.RequestOptions`

client.previewApIs.getOrderDeletions({ ...params }) -> Samsara.OrdersGetOrderDeletionsResponseBody

#### 📝 Description

Returns deletion markers for order replication. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

#### 🔌 Usage

```typescript await client.previewApIs.getOrderDeletions(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetOrderDeletionsRequest`

**requestOptions:** `PreviewApIsClient.RequestOptions`

client.previewApIs.getOrdersStream({ ...params }) -> Samsara.OrdersGetOrdersStreamResponseBody

#### 📝 Description

Returns live order create and update state for replication. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

#### 🔌 Usage

```typescript await client.previewApIs.getOrdersStream({ startTime: "2024-01-15T09:30:00Z" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetOrdersStreamRequest`

**requestOptions:** `PreviewApIsClient.RequestOptions`

client.previewApIs.lockVehicle({ ...params }) -> void

#### 📝 Description

Lock a vehicle. This requires a vehicle gateway with locking capabilities. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Vehicle Lock/Unlock** under the Vehicles category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

#### 🔌 Usage

```typescript await client.previewApIs.lockVehicle({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.LockVehicleRequest`

**requestOptions:** `PreviewApIsClient.RequestOptions`

client.previewApIs.unlockVehicle({ ...params }) -> void

#### 📝 Description

Unlock a vehicle. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Vehicle Lock/Unlock** under the Vehicles category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API's interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

#### 🔌 Usage

```typescript await client.previewApIs.unlockVehicle({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.UnlockVehicleRequest`

**requestOptions:** `PreviewApIsClient.RequestOptions`

## Readings

client.readings.listReadingsDefinitions({ ...params }) -> Samsara.ReadingsListReadingsDefinitionsResponseBody

#### 📝 Description

An introspection endpoint for discovering the set of readings including their name, description, data type, unit, and other metadata. 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 **Read 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.

#### 🔌 Usage

```typescript await client.readings.listReadingsDefinitions(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListReadingsDefinitionsRequest`

**requestOptions:** `ReadingsClient.RequestOptions`

client.readings.getReadingsHistory({ ...params }) -> Samsara.ReadingsGetReadingsHistoryResponseBody

#### 📝 Description

Get the values of a reading for a set of entities within the specified time range. Returns a paginated response with data for the specified resource IDs where startTime <= happenedAtTime < endTime. If endTime is not set, the time of the request is used as the endTime. 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 **Read 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.

#### 🔌 Usage

```typescript await client.readings.getReadingsHistory({ readingId: "readingId", entityType: "entityType" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetReadingsHistoryRequest`

**requestOptions:** `ReadingsClient.RequestOptions`

client.readings.getReadingsSnapshot({ ...params }) -> Samsara.ReadingsGetReadingsSnapshotResponseBody

#### 📝 Description

An endpoint to get the last value of a reading for a set of entities at the specified time. 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 **Read 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.

#### 🔌 Usage

```typescript await client.readings.getReadingsSnapshot({ readingIds: "readingIds", entityType: "entityType" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetReadingsSnapshotRequest`

**requestOptions:** `ReadingsClient.RequestOptions`

## RouteEvents

client.routeEvents.getRouteEventsStream({ ...params }) -> Samsara.RoutesGetRouteEventsStreamResponseBody

#### 📝 Description

Subscribes to a feed of immutable, append-only updates for routes. The initial request to this feed endpoint returns a cursor, which can be used in subsequent requests to fetch events on all routes that occurred after the last retrieved event. An initial request (with empty after and startTime parameters) will return events from the past 24 hours. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. Learn More. **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.

#### 🔌 Usage

```typescript await client.routeEvents.getRouteEventsStream(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetRouteEventsStreamRequest`

**requestOptions:** `RouteEventsClient.RequestOptions`

## Safety

client.safety.getSafetyEventsV2({ ...params }) -> Samsara.SafetyEventsV2GetSafetyEventsV2ResponseBody

#### 📝 Description

This endpoint will return details for the specified safety events based on the parameters passed in. Results are paginated. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read 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.

#### 🔌 Usage

```typescript await client.safety.getSafetyEventsV2(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetSafetyEventsV2Request`

**requestOptions:** `SafetyClient.RequestOptions`

client.safety.getSafetyEventsV2Stream({ ...params }) -> Samsara.SafetyEventsV2GetSafetyEventsV2StreamResponseBody

#### 📝 Description

This endpoint will return all safety events associated with your organization based on the parameters passed in. To get core endpoint data, select Read Safety Events & Scores under the Safety & Cameras category when creating or editing an API token. Read Camera Media permissions required to get Safety Event video media via this endpoint. If you include an endTime, the endpoint will return data up until that point. If you do not 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 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.

#### 🔌 Usage

```typescript await client.safety.getSafetyEventsV2Stream({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetSafetyEventsV2StreamRequest`

**requestOptions:** `SafetyClient.RequestOptions`

client.safety.v1GetDriverSafetyScore({ ...params }) -> Samsara.V1DriverSafetyScoreResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch the safety score for the driver. Rate limit: 5 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 Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.safety.v1GetDriverSafetyScore({ driverId: 1000000, startMs: 1000000, endMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetDriverSafetyScoreRequest`

**requestOptions:** `SafetyClient.RequestOptions`

client.safety.v1GetVehicleSafetyScore({ ...params }) -> Samsara.V1VehicleSafetyScoreResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch the safety score for the vehicle. Rate limit: 5 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 Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.safety.v1GetVehicleSafetyScore({ vehicleId: 1000000, startMs: 1000000, endMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetVehicleSafetyScoreRequest`

**requestOptions:** `SafetyClient.RequestOptions`

## SafetyScores

client.safetyScores.getDriverSafetyScores({ ...params }) -> Samsara.SafetyScoresGetDriverSafetyScoresResponseBody

#### 📝 Description

Get safety scores and overall risk factors for drivers. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Read 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.

#### 🔌 Usage

```typescript await client.safetyScores.getDriverSafetyScores({ endTime: "endTime", startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetDriverSafetyScoresRequest`

**requestOptions:** `SafetyScoresClient.RequestOptions`

client.safetyScores.getTagGroupSafetyScores({ ...params }) -> Samsara.SafetyScoresGetTagGroupSafetyScoresResponseBody

#### 📝 Description

Get a combined safety score and risk factors for a set of tags. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Read 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.

#### 🔌 Usage

```typescript await client.safetyScores.getTagGroupSafetyScores({ endTime: "endTime", startTime: "startTime", scoreType: "driver" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTagGroupSafetyScoresRequest`

**requestOptions:** `SafetyScoresClient.RequestOptions`

client.safetyScores.getTagSafetyScores({ ...params }) -> Samsara.SafetyScoresGetTagSafetyScoresResponseBody

#### 📝 Description

Get safety scores and overall risk factors for tags. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Read 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.

#### 🔌 Usage

```typescript await client.safetyScores.getTagSafetyScores({ endTime: "endTime", startTime: "startTime", scoreType: "driver" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTagSafetyScoresRequest`

**requestOptions:** `SafetyScoresClient.RequestOptions`

client.safetyScores.getVehicleSafetyScores({ ...params }) -> Samsara.SafetyScoresGetVehicleSafetyScoresResponseBody

#### 📝 Description

Get safety scores and overall risk factors for vehicles. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Read 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.

#### 🔌 Usage

```typescript await client.safetyScores.getVehicleSafetyScores({ endTime: "endTime", startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetVehicleSafetyScoresRequest`

**requestOptions:** `SafetyScoresClient.RequestOptions`

## SpeedingIntervals

client.speedingIntervals.getSpeedingIntervals({ ...params }) -> Samsara.SpeedingIntervalsGetSpeedingIntervalsResponseBody

#### 📝 Description

This endpoint will return all speeding intervals associated with all trips that have been collected for your organization based on the time parameters passed in. Only completed trips are included. Trips with no speeding intervals detected will be returned with an empty list of intervals. Results are paginated. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Speeding Intervals** under the Speeding Intervals 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.

#### 🔌 Usage

```typescript await client.speedingIntervals.getSpeedingIntervals({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetSpeedingIntervalsRequest`

**requestOptions:** `SpeedingIntervalsClient.RequestOptions`

## Tags

client.tags.listTags({ ...params }) -> Samsara.ListTagsResponse

#### 📝 Description

Return all of the tags for an organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Tags** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.tags.listTags(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListTagsRequest`

**requestOptions:** `TagsClient.RequestOptions`

client.tags.createTag({ ...params }) -> Samsara.TagResponse

#### 📝 Description

Create a new tag for the organization. This may include up to 20,000 tagged entities. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Tags** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.tags.createTag({ name: "California" }); ```

#### ⚙️ Parameters

**request:** `Samsara.CreateTagRequest`

**requestOptions:** `TagsClient.RequestOptions`

client.tags.getTag({ ...params }) -> Samsara.TagResponse

#### 📝 Description

Fetch a tag by id. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Tags** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.tags.getTag({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTagRequest`

**requestOptions:** `TagsClient.RequestOptions`

client.tags.replaceTag({ ...params }) -> Samsara.TagResponse

#### 📝 Description

Update a tag with a new name and new members. This API call would replace all old members of a tag with new members specified in the request body. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Tags** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.tags.replaceTag({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.ReplaceTagRequest`

**requestOptions:** `TagsClient.RequestOptions`

client.tags.delete({ ...params }) -> void

#### 📝 Description

Permanently deletes a tag. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Tags** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.tags.delete({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteTagsRequest`

**requestOptions:** `TagsClient.RequestOptions`

client.tags.patchTag({ ...params }) -> Samsara.TagResponse

#### 📝 Description

Update an existing tag. **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. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Tags** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.tags.patchTag({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.PatchTagRequest`

**requestOptions:** `TagsClient.RequestOptions`

## TrainingAssignments

client.trainingAssignments.postTrainingAssignments({ ...params }) -> Samsara.TrainingAssignmentsPostTrainingAssignmentsResponseBody

#### 📝 Description

Create training assignments. Existing assignments will remain unchanged. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Write Training Assignments** under the Training 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.

#### 🔌 Usage

```typescript await client.trainingAssignments.postTrainingAssignments({ courseId: "courseId", dueAtTime: "dueAtTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.PostTrainingAssignmentsRequest`

**requestOptions:** `TrainingAssignmentsClient.RequestOptions`

client.trainingAssignments.deleteTrainingAssignments({ ...params }) -> void

#### 📝 Description

This endpoint supports batch deletion operations. The response does not indicate which specific deletions, if any, have failed. On a successful deletion or partial failure, a ‘204 No Content’ status is returned. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Write Training Assignments** under the Training 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.

#### 🔌 Usage

```typescript await client.trainingAssignments.deleteTrainingAssignments(); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteTrainingAssignmentsRequest`

**requestOptions:** `TrainingAssignmentsClient.RequestOptions`

client.trainingAssignments.patchTrainingAssignments({ ...params }) -> Samsara.TrainingAssignmentsPatchTrainingAssignmentsResponseBody

#### 📝 Description

Update training assignments. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Write Training Assignments** under the Training 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.

#### 🔌 Usage

```typescript await client.trainingAssignments.patchTrainingAssignments({ dueAtTime: "dueAtTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.PatchTrainingAssignmentsRequest`

**requestOptions:** `TrainingAssignmentsClient.RequestOptions`

client.trainingAssignments.getTrainingAssignmentsStream({ ...params }) -> Samsara.TrainingAssignmentsGetTrainingAssignmentsStreamResponseBody

#### 📝 Description

Returns all training assignments data that has 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 Training Assignments** under the Training 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.

#### 🔌 Usage

```typescript await client.trainingAssignments.getTrainingAssignmentsStream({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTrainingAssignmentsStreamRequest`

**requestOptions:** `TrainingAssignmentsClient.RequestOptions`

## TrainingCourses

client.trainingCourses.getTrainingCourses({ ...params }) -> Samsara.TrainingCoursesGetTrainingCoursesResponseBody

#### 📝 Description

Returns all training courses data. Results are paginated. Courses in the ‘draft’ status are excluded from the data returned by this endpoint. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Training Courses** under the Training Courses 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.

#### 🔌 Usage

```typescript await client.trainingCourses.getTrainingCourses(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTrainingCoursesRequest`

**requestOptions:** `TrainingCoursesClient.RequestOptions`

## Trips

client.trips.getTrips({ ...params }) -> Samsara.TripsGetTripsResponseBody

#### 📝 Description

This endpoint will return trips that have been collected for your organization based on the time parameters passed in. Results are paginated. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Trips** under the Trips 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.

#### 🔌 Usage

```typescript await client.trips.getTrips({ startTime: "startTime" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetTripsRequest`

**requestOptions:** `TripsClient.RequestOptions`

client.trips.v1GetFleetTrips({ ...params }) -> Samsara.V1TripResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get historical trips data for specified vehicle. This method returns a set of historical trips data for the specified vehicle in the specified time range. **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 Vehicle Trips** under the Vehicles category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.trips.v1GetFleetTrips({ vehicleId: 1000000, startMs: 1000000, endMs: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetFleetTripsRequest`

**requestOptions:** `TripsClient.RequestOptions`

## Users

client.users.listUserRoles({ ...params }) -> Samsara.ListUserRolesResponse

#### 📝 Description

Returns a list of all user roles in an organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Users** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.users.listUserRoles(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListUserRolesRequest`

**requestOptions:** `UsersClient.RequestOptions`

client.users.listUsers({ ...params }) -> Samsara.ListUsersResponse

#### 📝 Description

Returns a list of all users in an organization. Users that have expired access will not be returned. **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 Users** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.users.listUsers(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListUsersRequest`

**requestOptions:** `UsersClient.RequestOptions`

client.users.createUser({ ...params }) -> Samsara.UserResponse

#### 📝 Description

Add a user to the organization. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Users** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.users.createUser({ authType: "default", email: "user@company.com", name: "Bob Smith", roles: [{ roleId: "8a9371af-82d1-4158-bf91-4ecc8d3a114c" }] }); ```

#### ⚙️ Parameters

**request:** `Samsara.CreateUserRequest`

**requestOptions:** `UsersClient.RequestOptions`

client.users.getUser({ ...params }) -> Samsara.UserResponse

#### 📝 Description

Get a specific user's information. Users that have expired access will not be returned. **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 Users** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.users.getUser({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetUserRequest`

**requestOptions:** `UsersClient.RequestOptions`

client.users.delete({ ...params }) -> void

#### 📝 Description

Delete the given user. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Users** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.users.delete({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteUsersRequest`

**requestOptions:** `UsersClient.RequestOptions`

client.users.updateUser({ ...params }) -> Samsara.UserResponse

#### 📝 Description

Update a specific user's information. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Users** under the Setup & Administration category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.users.updateUser({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.UpdateUserRequest`

**requestOptions:** `UsersClient.RequestOptions`

## Legacy

client.legacy.v1GetAllAssets() -> Samsara.InlineResponse2001

#### 📝 Description

**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/listassets) instead. The endpoint will continue to function as documented.** Fetch all powered and unpowered equipment. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.legacy.v1GetAllAssets(); ```

#### ⚙️ Parameters

**requestOptions:** `LegacyClient.RequestOptions`

## Fleet

client.fleet.getFleetLocations({ ...params }) -> Samsara.FleetLocationsGetFleetLocationsResponseBody

#### 📝 Description

Get current location of vehicles. Rate limit: 50 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Vehicle Statistics** 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.

#### 🔌 Usage

```typescript await client.fleet.getFleetLocations(); ```

#### ⚙️ Parameters

**request:** `Samsara.GetFleetLocationsRequest`

**requestOptions:** `FleetClient.RequestOptions`

## Messages

client.messages.v1GetMessages({ ...params }) -> Samsara.InlineResponse2005

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get all messages. Rate limit: 100 requests/min (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 Messages** under the Driver Workflow category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.messages.v1GetMessages(); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetMessagesRequest`

**requestOptions:** `MessagesClient.RequestOptions`

client.messages.v1CreateMessages({ ...params }) -> Samsara.InlineResponse2006

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Send a message to a list of driver ids. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Messages** under the Driver Workflow category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.messages.v1CreateMessages({ driverIds: [111, 222, 333], text: "This is a message." }); ```

#### ⚙️ Parameters

**request:** `Samsara.InlineObject2`

**requestOptions:** `MessagesClient.RequestOptions`

## Trailer Assignments

client.trailerAssignments.v1GetAllTrailerAssignments({ ...params }) -> Samsara.InlineResponse2007

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch trailer assignment data for all trailers in your organization. Rate limit: 25 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 Assignments** under the Assignments category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.trailerAssignments.v1GetAllTrailerAssignments(); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetAllTrailerAssignmentsRequest`

**requestOptions:** `TrailerAssignmentsClient.RequestOptions`

client.trailerAssignments.v1GetFleetTrailerAssignments({ ...params }) -> Samsara.V1TrailerAssignmentsResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Fetch trailer assignment data for a single trailer. Rate limit: 25 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 Assignments** under the Assignments category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.trailerAssignments.v1GetFleetTrailerAssignments({ trailerId: 1000000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.V1GetFleetTrailerAssignmentsRequest`

**requestOptions:** `TrailerAssignmentsClient.RequestOptions`

## Sensors

client.sensors.v1GetSensorsCargo({ ...params }) -> Samsara.V1CargoResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get cargo monitor status (empty / full) for requested sensors. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.sensors.v1GetSensorsCargo({ sensors: [122] }); ```

#### ⚙️ Parameters

**request:** `Samsara.InlineObject4`

**requestOptions:** `SensorsClient.RequestOptions`

client.sensors.v1GetSensorsDoor({ ...params }) -> Samsara.V1DoorResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get door monitor status (closed / open) for requested sensors. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.sensors.v1GetSensorsDoor({ sensors: [122] }); ```

#### ⚙️ Parameters

**request:** `Samsara.InlineObject5`

**requestOptions:** `SensorsClient.RequestOptions`

client.sensors.v1GetSensorsHistory({ ...params }) -> Samsara.V1SensorHistoryResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get historical data for specified sensors. This method returns a set of historical data for the specified sensors in the specified time range and at the specified time resolution. Rate limit: 100 requests/min (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 **Write Sensors** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.sensors.v1GetSensorsHistory({ endMs: 1462881998034, series: [{ field: "ambientTemperature", widgetId: 1 }], startMs: 1462878398034, stepMs: 3600000 }); ```

#### ⚙️ Parameters

**request:** `Samsara.InlineObject6`

**requestOptions:** `SensorsClient.RequestOptions`

client.sensors.v1GetSensorsHumidity({ ...params }) -> Samsara.V1HumidityResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get humidity for requested sensors. This method returns the current relative humidity for the requested sensors. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.sensors.v1GetSensorsHumidity({ sensors: [122] }); ```

#### ⚙️ Parameters

**request:** `Samsara.InlineObject7`

**requestOptions:** `SensorsClient.RequestOptions`

client.sensors.v1GetSensors() -> Samsara.InlineResponse2009

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get sensor objects. This method returns a list of the sensor objects in the Samsara Cloud and information about them. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.sensors.v1GetSensors(); ```

#### ⚙️ Parameters

**requestOptions:** `SensorsClient.RequestOptions`

client.sensors.v1GetSensorsTemperature({ ...params }) -> Samsara.V1TemperatureResponse

#### 📝 Description

> 🚧 This endpoint is still on our legacy API. Get temperature for requested sensors. This method returns the current ambient temperature (and probe temperature if applicable) for the requested sensors. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.sensors.v1GetSensorsTemperature({ sensors: [122] }); ```

#### ⚙️ Parameters

**request:** `Samsara.InlineObject8`

**requestOptions:** `SensorsClient.RequestOptions`

## Webhooks

client.webhooks.listWebhooks({ ...params }) -> Samsara.WebhooksListWebhooksResponseBody

#### 📝 Description

List all webhooks belonging to a specific org. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** 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.

#### 🔌 Usage

```typescript await client.webhooks.listWebhooks(); ```

#### ⚙️ Parameters

**request:** `Samsara.ListWebhooksRequest`

**requestOptions:** `WebhooksClient.RequestOptions`

client.webhooks.postWebhooks({ ...params }) -> Samsara.WebhooksPostWebhooksResponseBody

#### 📝 Description

Create a webhook Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** 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.

#### 🔌 Usage

```typescript await client.webhooks.postWebhooks({ name: "Webhook-123", url: "https://www.Webhook-123.com/webhook/listener" }); ```

#### ⚙️ Parameters

**request:** `Samsara.WebhooksPostWebhooksRequestBody`

**requestOptions:** `WebhooksClient.RequestOptions`

client.webhooks.getWebhook({ ...params }) -> Samsara.WebhooksGetWebhookResponseBody

#### 📝 Description

Retrieve a webhook with given ID. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** 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.

#### 🔌 Usage

```typescript await client.webhooks.getWebhook({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.GetWebhookRequest`

**requestOptions:** `WebhooksClient.RequestOptions`

client.webhooks.deleteWebhook({ ...params }) -> void

#### 📝 Description

Delete a webhook with the given ID. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** 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.

#### 🔌 Usage

```typescript await client.webhooks.deleteWebhook({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.DeleteWebhookRequest`

**requestOptions:** `WebhooksClient.RequestOptions`

client.webhooks.patchWebhook({ ...params }) -> Samsara.WebhooksPatchWebhookResponseBody

#### 📝 Description

Update a specific webhook's information. **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 Webhooks** 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.

#### 🔌 Usage

```typescript await client.webhooks.patchWebhook({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.WebhooksPatchWebhookRequestBody`

**requestOptions:** `WebhooksClient.RequestOptions`

## Fleet CarrierProposedAssignments

client.fleet.carrierProposedAssignments.delete({ ...params }) -> void

#### 📝 Description

Permanently delete an assignment. You can only delete assignments that are not yet active. To override a currently active assignment, create a new empty one, instead. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Carrier-Proposed Assignments** under the Assignments category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.fleet.carrierProposedAssignments.delete({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.fleet.DeleteCarrierProposedAssignmentsRequest`

**requestOptions:** `CarrierProposedAssignmentsClient.RequestOptions`

## Fleet Attributes

client.fleet.attributes.update({ ...params }) -> void

#### 🔌 Usage

```typescript await client.fleet.attributes.update({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.fleet.UpdateAttributesRequest`

**requestOptions:** `AttributesClient.RequestOptions`

## Industrial Assets

client.industrial.assets.delete({ ...params }) -> void

#### 📝 Description

Delete asset. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. Learn More.

#### 🔌 Usage

```typescript await client.industrial.assets.delete({ id: "id" }); ```

#### ⚙️ Parameters

**request:** `Samsara.industrial.DeleteAssetsRequest`

**requestOptions:** `AssetsClient.RequestOptions`