/**
* Samsara API
* # Overview Something new! Welcome Samsara\'s new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what\'s changed and learn how to get started.
Want to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).
*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can\'t find an API that you\'re looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*
Submit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)! Samsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets. The Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you\'re familiar with what you can build with a REST API, then this will be your go-to API reference. Visit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview. If you have any questions, please visit https://samsara.com/help. ## Endpoints All our APIs can be accessed through HTTP requests to URLs like: ``` https://api.samsara.com/ ``` For EU customers, this URL will be: ``` https://api.eu.samsara.com/ ``` Note Legacy endpoints will have the URL: `https://api.samsara.com/v1/` or `https://api.eu.samsara.com/v1/` ## Authentication To authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings->Organization->API Tokens`. Your API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on. Authentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password: ```curl Authorization: Bearer {access_token} ``` All API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail. ### OAuth2 If building an application for our marketplace, our API is accessible via. OAuth2 as well. | Type | Value | | ------------- |:-------------:| | Security scheme | OAuth2 | | OAuth2 Flow | accessCode | | Authorization URL | https://api.samsara.com/oauth2/authorize | | Token URL | https://api.samsara.com/oauth2/token | ## Common Patterns You can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures).
*
* The version of the OpenAPI document: 2024-11-18
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { RequestArgs, BaseAPI } from '../base';
import { AempEquipmentGetAempEquipmentListResponseBody } from '../samsara-models';
import { AssetsCreateAssetRequestBody } from '../samsara-models';
import { AssetsCreateAssetResponseBody } from '../samsara-models';
import { AssetsInputsGetAssetsInputsResponseBody } from '../samsara-models';
import { AssetsListAssetsResponseBody } from '../samsara-models';
import { AssetsUpdateAssetRequestBody } from '../samsara-models';
import { AssetsUpdateAssetResponseBody } from '../samsara-models';
import { DevicesGetDevicesResponseBody } from '../samsara-models';
import { DriverEfficienciesResponse } from '../samsara-models';
import { DriverRemoteSignoutPostDriverRemoteSignoutRequestBody } from '../samsara-models';
import { DriverRemoteSignoutPostDriverRemoteSignoutResponseBody } from '../samsara-models';
import { EngineImmobilizerGetEngineImmobilizerStatesResponseBody } from '../samsara-models';
import { EngineImmobilizerUpdateEngineImmobilizerStateRequestBody } from '../samsara-models';
import { EquipmentPatchEquipmentRequestBody } from '../samsara-models';
import { EquipmentPatchEquipmentResponseBody } from '../samsara-models';
import { FormSubmissionsGetFormSubmissionsPdfExportsResponseBody } from '../samsara-models';
import { FormSubmissionsGetFormSubmissionsResponseBody } from '../samsara-models';
import { FormSubmissionsGetFormSubmissionsStreamResponseBody } from '../samsara-models';
import { FormSubmissionsPatchFormSubmissionRequestBody } from '../samsara-models';
import { FormSubmissionsPatchFormSubmissionResponseBody } from '../samsara-models';
import { FormSubmissionsPostFormSubmissionRequestBody } from '../samsara-models';
import { FormSubmissionsPostFormSubmissionResponseBody } from '../samsara-models';
import { FormSubmissionsPostFormSubmissionsPdfExportsResponseBody } from '../samsara-models';
import { HosDailyLogsUpdateShippingDocsRequestBody } from '../samsara-models';
import { HosDailyLogsUpdateShippingDocsResponseBody } from '../samsara-models';
import { HosEldEventsGetHosEldEventsResponseBody } from '../samsara-models';
import { IssuesGetIssuesResponseBody } from '../samsara-models';
import { IssuesGetIssuesStreamResponseBody } from '../samsara-models';
import { IssuesPatchIssueRequestBody } from '../samsara-models';
import { IssuesPatchIssueResponseBody } from '../samsara-models';
import { JobsCreateJobRequestBody } from '../samsara-models';
import { JobsCreateJobResponseBody } from '../samsara-models';
import { JobsDeleteJobResponseBody } from '../samsara-models';
import { JobsGetJobsResponseBody } from '../samsara-models';
import { JobsPatchJobRequestBody } from '../samsara-models';
import { JobsPatchJobResponseBody } from '../samsara-models';
import { MediaRetrievalGetMediaRetrievalResponseBody } from '../samsara-models';
import { MediaRetrievalListUploadedMediaResponseBody } from '../samsara-models';
import { MediaRetrievalPostMediaRetrievalRequestBody } from '../samsara-models';
import { MediaRetrievalPostMediaRetrievalResponseBody } from '../samsara-models';
import { SpeedingIntervalsGetSpeedingIntervalsResponseBody } from '../samsara-models';
import { TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody } from '../samsara-models';
import { TrailerAssignmentsCreateDriverTrailerAssignmentResponseBody } from '../samsara-models';
import { TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody } from '../samsara-models';
import { TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody } from '../samsara-models';
import { TrailerAssignmentsUpdateDriverTrailerAssignmentResponseBody } from '../samsara-models';
import { TrailerStatsGetTrailerStatsFeedResponseBody } from '../samsara-models';
import { TrailerStatsGetTrailerStatsHistoryResponseBody } from '../samsara-models';
import { TrailerStatsGetTrailerStatsSnapshotResponseBody } from '../samsara-models';
import { TrainingAssignmentsGetTrainingAssignmentsStreamResponseBody } from '../samsara-models';
import { TrainingAssignmentsPatchTrainingAssignmentsResponseBody } from '../samsara-models';
import { TrainingAssignmentsPostTrainingAssignmentsResponseBody } from '../samsara-models';
import { TrainingCoursesGetTrainingCoursesResponseBody } from '../samsara-models';
import { TripsGetTripsResponseBody } from '../samsara-models';
/**
* BetaAPIsApi - axios parameter creator
* @export
*/
export declare const BetaAPIsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* 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.
* @summary [beta] Create a new asset.
* @param {AssetsCreateAssetRequestBody} createAssetRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createAsset: (createAssetRequestBody: AssetsCreateAssetRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Create a new driver-trailer assignment
* @param {TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody} createDriverTrailerAssignmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDriverTrailerAssignment: (createDriverTrailerAssignmentRequestBody: TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Create a job
* @param {JobsCreateJobRequestBody} createJobRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createJob: (createJobRequestBody: JobsCreateJobRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Delete an existing asset.
* @param {string} id A filter selecting a single asset by id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteAsset: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Deletes an existing job
* @param {string} id A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteJob: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization. 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.
* @summary [beta] Delete training assignments.
* @param {Array} ids String of comma separated assignments IDs. Max value for this value is 100 objects .Example: `ids=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteTrainingAssignments: (ids: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Get a list of AEMP equipment
* @param {string} pageNumber The number corresponding to a specific page of paginated results, defaulting to the first page if not provided. The default page size is 100 records.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAempEquipmentList: (pageNumber: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] List asset inputs data in an organization.
* @param {Array} ids Comma-separated list of asset IDs. Limited to 100 ID\'s for each request.
* @param {GetAssetsInputsTypeEnum} type Input stat type to query for. Valid values: `auxInput1`, `auxInput2`, `auxInput3`, `auxInput4`, `auxInput5`, `auxInput6`, `auxInput7`, `auxInput8`, `auxInput9`, `auxInput10`, `auxInput11`, `auxInput12`, `auxInput13`, `analogInput1Voltage`, `analogInput2Voltage`, `analogInput1Current`, `analogInput2Current`, `batteryVoltage`
* @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to never if not provided; if not provided then pagination will not cease, and a valid pagination cursor will always be returned. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {boolean} [includeTags] Optional boolean indicating whether to return tags on supported entities
* @param {boolean} [includeAttributes] Optional boolean indicating whether to return attributes on supported entities
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAssetsInputs: (ids: Array, type: GetAssetsInputsTypeEnum, startTime: string, after?: string, endTime?: string, includeExternalIds?: boolean, includeTags?: boolean, includeAttributes?: boolean, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns all installed cameras (CM3x), vehicle gateways (VGs), and asset gateways (AGs) 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.
* @summary [beta] List devices.
* @param {Array} [models] Optional string of comma separated device models. Valid values: `CM31`, `CM32`, `CM33`, `CM34`, `VG34`, `VG34M`, `VG34EU`, `VG34FN`, `VG54NA`, `VG54EU`, `VG55NA`, `VG55EU`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`
* @param {Array} [healthStatuses] Optional string of comma separated device health statuses. Valid values: `healthy`, `needsAttention`, `needsReplacement`, `dataPending`.
* @param {boolean} [includeHealth] Optional boolean to control whether device health information is returned in the response. Defaults to false.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 100 objects.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDevices: (models?: Array, healthStatuses?: Array, includeHealth?: boolean, after?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Get all driver and associated vehicle efficiency data. 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.
* @summary [beta] List driver efficiency
* @param {GetDriverEfficiencyDriverActivationStatusEnum} [driverActivationStatus] If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers).
* @param {Array} [driverIds] A filter on the data based on this comma-separated list of driver IDs. Cannot be used with tag filtering or driver status. Example: `driverIds=1234,5678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [driverTagIds] Filters summary to drivers based on this comma-separated list of tag IDs. Data from all the drivers\' respective vehicles will be included in the summary, regardless of which tag the vehicle is associated with. Should not be provided in addition to `driverIds`. Example: driverTagIds=1234,5678
* @param {Array} [driverParentTagIds] Filters like `driverTagIds` but includes descendants of all the given parent tags. Should not be provided in addition to `driverIds`. Example: `driverParentTagIds=1234,5678`
* @param {string} [startTime] A start time in RFC 3339 format. The results will be truncated to the hour mark for the provided time. For example, if `startTime` is 2020-03-17T12:06:19Z then the results will include data starting from 2020-03-17T12:00:00Z. The provided start time cannot be in the future. Start time can be at most 31 days before the end time. If the start time is within the last hour, the results will be empty. Default: 24 hours prior to endTime. Note that 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.
* @param {string} [endTime] An end time in RFC 3339 format. The results will be truncated to the hour mark for the provided time. For example, if `endTime` is 2020-03-17T12:06:19Z then the results will include data up until 2020-03-17T12:00:00Z. The provided end time cannot be in the future. End time can be at most 31 days after the start time. Default: The current time truncated to the hour mark. Note that 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
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverEfficiency: (driverActivationStatus?: GetDriverEfficiencyDriverActivationStatusEnum, driverIds?: Array, after?: string, driverTagIds?: Array, driverParentTagIds?: Array, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Get currently active driver-trailer assignments for driver.
* @param {Array} driverIds A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverTrailerAssignments: (driverIds: Array, after?: string, includeExternalIds?: boolean, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Get engine immobilizer states
* @param {string} vehicleIds A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getEngineImmobilizerStates: (vehicleIds: string, startTime: string, endTime?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns all form submissions data for the specified IDs. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** 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.
* @summary [beta] Get a list of specified form submissions.
* @param {Array} ids A comma-separated list containing up to 100 form submission IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the form submission.
* @param {Array} [include] A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFormSubmissions: (ids: Array, include?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a PDF export for a form submission. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** 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.
* @summary [beta] Return a PDF export for a form submission.
* @param {string} pdfId ID of the form submission PDF export.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFormSubmissionsPdfExports: (pdfId: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** 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.
* @summary [beta] Get a stream of filtered form submissions.
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [formTemplateIds] A comma-separated list containing up to 50 template IDs to filter data to.
* @param {Array} [userIds] A comma-separated list containing up to 50 user IDs to filter data to.
* @param {Array} [driverIds] A comma-separated list containing up to 50 user IDs to filter data to.
* @param {Array} [include] A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`
* @param {Array} [assignedToRouteStopIds] A comma-separated list containing up to 50 route stop IDs to filter data to.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFormSubmissionsStream: (startTime: string, endTime?: string, after?: string, formTemplateIds?: Array, userIds?: Array, driverIds?: Array, include?: Array, assignedToRouteStopIds?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Get driver HOS ELD events
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [driverIds] A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {GetHosEldEventsDriverActivationStatusEnum} [driverActivationStatus] If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers). Valid values: `active`, `deactivated`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 25 objects.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getHosEldEvents: (startTime: string, endTime: string, driverIds?: Array, tagIds?: string, parentTagIds?: string, driverActivationStatus?: GetHosEldEventsDriverActivationStatusEnum, after?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns all issues data for the specified IDs. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Issues** 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.
* @summary [beta] Get a list of specified issues.
* @param {Array} ids A comma-separated list containing up to 100 issue IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the issue.
* @param {Array} [include] A comma separated list of additional fields to include on requested objects. Valid values: `externalIds`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIssues: (ids: Array, include?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Issues** 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.
* @summary [beta] Get a stream of filtered issues.
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [status] A comma-separated list containing status values to filter issues on. Valid values: `open`, `inProgress`, `resolved`, `dismissed`
* @param {Array} [assetIds] A comma-separated list containing up to 50 asset IDs to filter issues on. Issues with untracked assets can also be included by passing the value: \'untracked\'.
* @param {Array} [include] A comma separated list of additional fields to include on requested objects. Valid values: `externalIds`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIssuesStream: (startTime: string, endTime?: string, after?: string, status?: Array, assetIds?: Array, include?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Fetches all jobs
* @param {string} [id] A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`).
* @param {string} [startDate] A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endDate] An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [industrialAssetIds] IndustrialAssetId in STRING format. (Example: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`).
* @param {Array} [fleetDeviceIds] FleetDeviceId in INTEGER format. (Example: `123456`).
* @param {GetJobsStatusEnum} [status] A job status in STRING format. Job statuses can be one of three (ignores case): `\"active\", \"scheduled\", \"completed\"` Valid values: `active`, `scheduled`, `completed`
* @param {string} [customerName] Customer name to filter by
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getJobs: (id?: string, startDate?: string, endDate?: string, industrialAssetIds?: Array, fleetDeviceIds?: Array, status?: GetJobsStatusEnum, customerName?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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: 100 requests/min (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.
* @summary [beta] Get details for a media retrieval request
* @param {string} retrievalId Retrieval ID associated with this media capture request. Examples: 2308cec4-82e0-46f1-8b3c-a3592e5cc21e
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMediaRetrieval: (retrievalId: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This endpoint will return all speeding intervals associated with trips that have been collected for your organization based on the time parameters passed in. Only completed trips are included. 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.
* @summary [beta] Get Speeding Intervals
* @param {Array} assetIds Comma-separated list of asset IDs. Include up to 50 asset IDs.
* @param {string} startTime RFC 3339 timestamp that indicates when to begin receiving data. Value is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter.
* @param {string} [endTime] RFC 3339 timestamp which is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter. If not provided then the endpoint behaves as an unending feed of changes.
* @param {GetSpeedingIntervalsQueryByEnum} [queryBy] Decide which timestamp the `startTime` and `endTime` are compared to. Valid values: `updatedAtTime`, `tripStartTime`
* @param {boolean} [includeAsset] Indicates whether or not to return expanded “asset” data
* @param {boolean} [includeDriverId] Indicates whether or not to return trip\'s driver id
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [severityLevels] Optional string of comma-separated severity levels to filter speeding intervals by. Valid values: “light”, ”moderate”, ”heavy”, “severe”.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSpeedingIntervals: (assetIds: Array, startTime: string, endTime?: string, queryBy?: GetSpeedingIntervalsQueryByEnum, includeAsset?: boolean, includeDriverId?: boolean, after?: string, severityLevels?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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. 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.
* @summary [beta] Get trailer stats feed
* @param {string} types The stat types you want this endpoint to return information on. You may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [trailerIds] A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} [decorations] Decorations add to the primary stats listed in the `types` parameter. For example, if you wish to know the trailer\'s location whenever the odometer updates, you may set `types=gpsOdometerMeters&decorations=gps`. You may list **up to 2** types using comma-separated format. If multiple stats are listed in the types parameter, the decorations will be added to each type. For example: `types=reeferStateZone1,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters&decorations=gps` will list GPS decorations for each reeferStateZone1 reading, each reeferAmbientAirTemperatureMilliC reding, and gpsOdometerMeters reading. Note that decorations may significantly increase the response payload size. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrailerStatsFeed: (types: string, tagIds?: string, parentTagIds?: string, after?: string, trailerIds?: string, decorations?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Get trailer stats history
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} types The stat types you want this endpoint to return information on. You may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [trailerIds] A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} [decorations] Decorations add to the primary stats listed in the `types` parameter. For example, if you wish to know the trailer\'s location whenever the odometer updates, you may set `types=gpsOdometerMeters&decorations=gps`. You may list **up to 2** types using comma-separated format. If multiple stats are listed in the types parameter, the decorations will be added to each type. For example: `types=reeferStateZone1,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters&decorations=gps` will list GPS decorations for each reeferStateZone1 reading, each reeferAmbientAirTemperatureMilliC reding, and gpsOdometerMeters reading. Note that decorations may significantly increase the response payload size. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrailerStatsHistory: (startTime: string, endTime: string, types: string, tagIds?: string, parentTagIds?: string, after?: string, trailerIds?: string, decorations?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Get trailer stats
* @param {string} types The stat types you want this endpoint to return information on. You may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [trailerIds] A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} [time] A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 Format. Millisecond precision and timezones are supported.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrailerStatsSnapshot: (types: string, tagIds?: string, parentTagIds?: string, after?: string, trailerIds?: string, time?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization. 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.
* @summary [beta] Get a stream of filtered training assignments.
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [learnerIds] Optional string of comma separated learner IDs. If learner ID is present, training assignments for the specified learner(s) will be returned. Max value for this value is 100 objects. Example: `learnerIds=driver-281474,driver-46282156`
* @param {Array} [courseIds] Optional string of comma separated course IDs. If course ID is present, training assignments for the specified course ID(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `courseIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {Array} [status] Optional string of comma separated values. If status is present, training assignments for the specified status(s) will be returned. Valid values: \"notStarted\", \"inProgress\", \"completed\". Defaults to returning all courses.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrainingAssignmentsStream: (startTime: string, after?: string, endTime?: string, learnerIds?: Array, courseIds?: Array, status?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Get a list of filtered training courses.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [courseIds] Optional string of comma separated course IDs. If course ID is present, training assignments for the specified course ID(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `courseIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {Array} [categoryIds] Optional string of comma separated course category IDs. If courseCategoryId is present, training courses for the specified course category(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `categoryIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {Array} [status] Optional string of comma separated values. If status is present, training courses with the specified status(s) will be returned. Valid values: “published”, “deleted”, “archived”. Defaults to returning all courses.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrainingCourses: (after?: string, courseIds?: Array, categoryIds?: Array, status?: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* This endpoint will return trips that have been collected for your organization based on the time parameters passed in. Results are paginated. Reach out to your Samsara Representative to have this API enabled for your organization. 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.
* @summary [beta] Get trips
* @param {string} startTime RFC 3339 timestamp that indicates when to begin receiving data. Value is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter.
* @param {Array} ids Comma-separated list of asset IDs. Include up to 50 asset IDs.
* @param {boolean} [includeAsset] Indicates whether or not to return expanded “asset” data
* @param {GetTripsCompletionStatusEnum} [completionStatus] Filters trips based on a specific completion status Valid values: `inProgress`, `completed`, `all`
* @param {string} [endTime] RFC 3339 timestamp which is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter. If not provided then the endpoint behaves as an unending feed of changes.
* @param {GetTripsQueryByEnum} [queryBy] Decide which timestamp the `startTime` and `endTime` are compared to. Valid values: `updatedAtTime`, `tripStartTime`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrips: (startTime: string, ids: Array, includeAsset?: boolean, completionStatus?: GetTripsCompletionStatusEnum, endTime?: string, queryBy?: GetTripsQueryByEnum, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] List all assets.
* @param {ListAssetsTypeEnum} [type] The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [updatedAfterTime] A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {boolean} [includeTags] Optional boolean indicating whether to return tags on supported entities
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [ids] A filter on the data based on this comma-separated list of asset IDs and External IDs.
* @param {string} [attributeValueIds] A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listAssets: (type?: ListAssetsTypeEnum, after?: string, updatedAfterTime?: string, includeExternalIds?: boolean, includeTags?: boolean, tagIds?: string, parentTagIds?: string, ids?: Array, attributeValueIds?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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: 100 requests/min (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.
* @summary [beta] List uploaded media by time range.
* @param {string} vehicleIds A filter on the data based on this comma-separated list of vehicle IDs and externalIds. You can specify up to 20 vehicles. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. End time cannot be more than 24 hours after startTime. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [inputs] An optional list of desired camera inputs for which to return captured media. If empty, media for all available inputs will be returned. Possible options include: dashcamRoadFacing, dashcamDriverFacing, analog.
* @param {Array} [mediaTypes] An optional list of desired media types for which to return captured media. If empty, media for all available media types will be returned. Possible options include: IMAGE, VIDEO_HIGH_RES.
* @param {Array} [triggerReasons] An optional list of desired trigger reasons for which to return captured media. If empty, media for all available trigger reasons will be returned. Possible options include: api, panicButton, periodicStill, safetyEvent, tripEndStill, tripStartStill, videoRetrieval. videoRetrieval represents media captured for a dashboard video retrieval request.
* @param {string} [availableAfterTime] An optional timestamp in RFC 3339 format that can act as a cursor to track which media has previously been retrieved; only media whose availableAtTime comes after this parameter will be returned. Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listUploadedMedia: (vehicleIds: string, startTime: string, endTime: string, inputs?: Array, mediaTypes?: Array, triggerReasons?: Array, availableAfterTime?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Update an equipment
* @param {string} id The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed.
* @param {EquipmentPatchEquipmentRequestBody} patchEquipmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchEquipment: (id: string, patchEquipmentRequestBody: EquipmentPatchEquipmentRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Updates an instance of a form submission. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Form Submissions** 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.
* @summary [beta] Update a single form submission.
* @param {FormSubmissionsPatchFormSubmissionRequestBody} patchFormSubmissionRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchFormSubmission: (patchFormSubmissionRequestBody: FormSubmissionsPatchFormSubmissionRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Updates an instance of an issue. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Issues** 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.
* @summary [beta] Update a single issue.
* @param {IssuesPatchIssueRequestBody} patchIssueRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchIssue: (patchIssueRequestBody: IssuesPatchIssueRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Patches a job
* @param {string} id A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`).
* @param {JobsPatchJobRequestBody} patchJobRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchJob: (id: string, patchJobRequestBody: JobsPatchJobRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Update training assignments. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization. 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.
* @summary [beta] Update training assignments.
* @param {Array} ids String of comma separated assignments IDs. Max value for this value is 100 objects .Example: `ids=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {string} dueAtTime Due date of the training assignment in RFC 3339 format. Millisecond precision and timezones are supported.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchTrainingAssignments: (ids: Array, dueAtTime: string, options?: RawAxiosRequestConfig) => Promise;
/**
* 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 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.
* @summary [beta] Sign out a driver
* @param {DriverRemoteSignoutPostDriverRemoteSignoutRequestBody} postDriverRemoteSignoutRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postDriverRemoteSignout: (postDriverRemoteSignoutRequestBody: DriverRemoteSignoutPostDriverRemoteSignoutRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Creates a form submission. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Form Submissions** 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.
* @summary [beta] Create a form submission.
* @param {FormSubmissionsPostFormSubmissionRequestBody} postFormSubmissionRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postFormSubmission: (postFormSubmissionRequestBody: FormSubmissionsPostFormSubmissionRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Creates a PDF export for a form submission. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Form Submissions** 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.
* @summary [beta] Create a PDF export for a form submission.
* @param {string} id ID of the form submission to create a PDF export from.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postFormSubmissionsPdfExports: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This endpoint creates an asynchronous request to upload certain media from a device. The closest available media to the requested timestamp is returned. Images and high-res videos are supported; other types of media (e.g. hyperlapse, low-res) are planned to be supported in the future. Currently, only unblurred media is supported. If a device is offline, the requested media will be uploaded once it comes back online. Quota limits for media requests will be enforced in GA, but not in closed beta. 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.
* @summary [beta] Create a media retrieval request
* @param {MediaRetrievalPostMediaRetrievalRequestBody} postMediaRetrievalRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postMediaRetrieval: (postMediaRetrievalRequestBody: MediaRetrievalPostMediaRetrievalRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Create training assignments. Existing assignments will remain unchanged. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization. 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.
* @summary [beta] Create training assignments.
* @param {string} courseId String for the course ID.
* @param {string} dueAtTime Due date of the training assignment in RFC 3339 format. Millisecond precision and timezones are supported.
* @param {Array} learnerIds Optional string of comma separated learner IDs. If learner ID is present, training assignments for the specified learner(s) will be returned. Max value for this value is 100 objects. Example: `learnerIds=driver-281474,driver-46282156`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postTrainingAssignments: (courseId: string, dueAtTime: string, learnerIds: Array, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Update an existing asset.
* @param {string} id A filter selecting a single asset by id.
* @param {AssetsUpdateAssetRequestBody} updateAssetRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateAsset: (id: string, updateAssetRequestBody: AssetsUpdateAssetRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Update an existing driver-trailer assignment.
* @param {string} id Samsara ID for the assignment.
* @param {TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody} updateDriverTrailerAssignmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDriverTrailerAssignment: (id: string, updateDriverTrailerAssignmentRequestBody: TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Update engine immobilizer state of a vehicle.
* @param {number} id Vehicle ID
* @param {EngineImmobilizerUpdateEngineImmobilizerStateRequestBody} updateEngineImmobilizerStateRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateEngineImmobilizerState: (id: number, updateEngineImmobilizerStateRequestBody: EngineImmobilizerUpdateEngineImmobilizerStateRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* 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.
* @summary [beta] Update the shippingDocs field of an existing assignment.
* @param {string} hosDate A start date in yyyy-mm-dd format. Required.
* @param {string} driverID ID of the driver for whom the duty status is being set.
* @param {HosDailyLogsUpdateShippingDocsRequestBody} updateShippingDocsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateShippingDocs: (hosDate: string, driverID: string, updateShippingDocsRequestBody: HosDailyLogsUpdateShippingDocsRequestBody, options?: RawAxiosRequestConfig) => Promise;
};
/**
* BetaAPIsApi - functional programming interface
* @export
*/
export declare const BetaAPIsApiFp: (configuration?: Configuration) => {
/**
* 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.
* @summary [beta] Create a new asset.
* @param {AssetsCreateAssetRequestBody} createAssetRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createAsset(createAssetRequestBody: AssetsCreateAssetRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Create a new driver-trailer assignment
* @param {TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody} createDriverTrailerAssignmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDriverTrailerAssignment(createDriverTrailerAssignmentRequestBody: TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Create a job
* @param {JobsCreateJobRequestBody} createJobRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createJob(createJobRequestBody: JobsCreateJobRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Delete an existing asset.
* @param {string} id A filter selecting a single asset by id.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteAsset(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Deletes an existing job
* @param {string} id A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`).
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteJob(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization. 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.
* @summary [beta] Delete training assignments.
* @param {Array} ids String of comma separated assignments IDs. Max value for this value is 100 objects .Example: `ids=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteTrainingAssignments(ids: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Get a list of AEMP equipment
* @param {string} pageNumber The number corresponding to a specific page of paginated results, defaulting to the first page if not provided. The default page size is 100 records.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAempEquipmentList(pageNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] List asset inputs data in an organization.
* @param {Array} ids Comma-separated list of asset IDs. Limited to 100 ID\'s for each request.
* @param {GetAssetsInputsTypeEnum} type Input stat type to query for. Valid values: `auxInput1`, `auxInput2`, `auxInput3`, `auxInput4`, `auxInput5`, `auxInput6`, `auxInput7`, `auxInput8`, `auxInput9`, `auxInput10`, `auxInput11`, `auxInput12`, `auxInput13`, `analogInput1Voltage`, `analogInput2Voltage`, `analogInput1Current`, `analogInput2Current`, `batteryVoltage`
* @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to never if not provided; if not provided then pagination will not cease, and a valid pagination cursor will always be returned. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {boolean} [includeTags] Optional boolean indicating whether to return tags on supported entities
* @param {boolean} [includeAttributes] Optional boolean indicating whether to return attributes on supported entities
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAssetsInputs(ids: Array, type: GetAssetsInputsTypeEnum, startTime: string, after?: string, endTime?: string, includeExternalIds?: boolean, includeTags?: boolean, includeAttributes?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns all installed cameras (CM3x), vehicle gateways (VGs), and asset gateways (AGs) 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.
* @summary [beta] List devices.
* @param {Array} [models] Optional string of comma separated device models. Valid values: `CM31`, `CM32`, `CM33`, `CM34`, `VG34`, `VG34M`, `VG34EU`, `VG34FN`, `VG54NA`, `VG54EU`, `VG55NA`, `VG55EU`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`
* @param {Array} [healthStatuses] Optional string of comma separated device health statuses. Valid values: `healthy`, `needsAttention`, `needsReplacement`, `dataPending`.
* @param {boolean} [includeHealth] Optional boolean to control whether device health information is returned in the response. Defaults to false.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 100 objects.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDevices(models?: Array, healthStatuses?: Array, includeHealth?: boolean, after?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get all driver and associated vehicle efficiency data. 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.
* @summary [beta] List driver efficiency
* @param {GetDriverEfficiencyDriverActivationStatusEnum} [driverActivationStatus] If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers).
* @param {Array} [driverIds] A filter on the data based on this comma-separated list of driver IDs. Cannot be used with tag filtering or driver status. Example: `driverIds=1234,5678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [driverTagIds] Filters summary to drivers based on this comma-separated list of tag IDs. Data from all the drivers\' respective vehicles will be included in the summary, regardless of which tag the vehicle is associated with. Should not be provided in addition to `driverIds`. Example: driverTagIds=1234,5678
* @param {Array} [driverParentTagIds] Filters like `driverTagIds` but includes descendants of all the given parent tags. Should not be provided in addition to `driverIds`. Example: `driverParentTagIds=1234,5678`
* @param {string} [startTime] A start time in RFC 3339 format. The results will be truncated to the hour mark for the provided time. For example, if `startTime` is 2020-03-17T12:06:19Z then the results will include data starting from 2020-03-17T12:00:00Z. The provided start time cannot be in the future. Start time can be at most 31 days before the end time. If the start time is within the last hour, the results will be empty. Default: 24 hours prior to endTime. Note that 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.
* @param {string} [endTime] An end time in RFC 3339 format. The results will be truncated to the hour mark for the provided time. For example, if `endTime` is 2020-03-17T12:06:19Z then the results will include data up until 2020-03-17T12:00:00Z. The provided end time cannot be in the future. End time can be at most 31 days after the start time. Default: The current time truncated to the hour mark. Note that 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
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverEfficiency(driverActivationStatus?: GetDriverEfficiencyDriverActivationStatusEnum, driverIds?: Array, after?: string, driverTagIds?: Array, driverParentTagIds?: Array, startTime?: string, endTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Get currently active driver-trailer assignments for driver.
* @param {Array} driverIds A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverTrailerAssignments(driverIds: Array, after?: string, includeExternalIds?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Get engine immobilizer states
* @param {string} vehicleIds A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getEngineImmobilizerStates(vehicleIds: string, startTime: string, endTime?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns all form submissions data for the specified IDs. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** 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.
* @summary [beta] Get a list of specified form submissions.
* @param {Array} ids A comma-separated list containing up to 100 form submission IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the form submission.
* @param {Array} [include] A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFormSubmissions(ids: Array, include?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a PDF export for a form submission. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** 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.
* @summary [beta] Return a PDF export for a form submission.
* @param {string} pdfId ID of the form submission PDF export.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFormSubmissionsPdfExports(pdfId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** 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.
* @summary [beta] Get a stream of filtered form submissions.
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [formTemplateIds] A comma-separated list containing up to 50 template IDs to filter data to.
* @param {Array} [userIds] A comma-separated list containing up to 50 user IDs to filter data to.
* @param {Array} [driverIds] A comma-separated list containing up to 50 user IDs to filter data to.
* @param {Array} [include] A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`
* @param {Array} [assignedToRouteStopIds] A comma-separated list containing up to 50 route stop IDs to filter data to.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFormSubmissionsStream(startTime: string, endTime?: string, after?: string, formTemplateIds?: Array, userIds?: Array, driverIds?: Array, include?: Array, assignedToRouteStopIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Get driver HOS ELD events
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [driverIds] A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {GetHosEldEventsDriverActivationStatusEnum} [driverActivationStatus] If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers). Valid values: `active`, `deactivated`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 25 objects.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getHosEldEvents(startTime: string, endTime: string, driverIds?: Array, tagIds?: string, parentTagIds?: string, driverActivationStatus?: GetHosEldEventsDriverActivationStatusEnum, after?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns all issues data for the specified IDs. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Issues** 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.
* @summary [beta] Get a list of specified issues.
* @param {Array} ids A comma-separated list containing up to 100 issue IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the issue.
* @param {Array} [include] A comma separated list of additional fields to include on requested objects. Valid values: `externalIds`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIssues(ids: Array, include?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Issues** 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.
* @summary [beta] Get a stream of filtered issues.
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [status] A comma-separated list containing status values to filter issues on. Valid values: `open`, `inProgress`, `resolved`, `dismissed`
* @param {Array} [assetIds] A comma-separated list containing up to 50 asset IDs to filter issues on. Issues with untracked assets can also be included by passing the value: \'untracked\'.
* @param {Array} [include] A comma separated list of additional fields to include on requested objects. Valid values: `externalIds`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getIssuesStream(startTime: string, endTime?: string, after?: string, status?: Array, assetIds?: Array, include?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Fetches all jobs
* @param {string} [id] A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`).
* @param {string} [startDate] A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endDate] An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [industrialAssetIds] IndustrialAssetId in STRING format. (Example: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`).
* @param {Array} [fleetDeviceIds] FleetDeviceId in INTEGER format. (Example: `123456`).
* @param {GetJobsStatusEnum} [status] A job status in STRING format. Job statuses can be one of three (ignores case): `\"active\", \"scheduled\", \"completed\"` Valid values: `active`, `scheduled`, `completed`
* @param {string} [customerName] Customer name to filter by
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getJobs(id?: string, startDate?: string, endDate?: string, industrialAssetIds?: Array, fleetDeviceIds?: Array, status?: GetJobsStatusEnum, customerName?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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: 100 requests/min (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.
* @summary [beta] Get details for a media retrieval request
* @param {string} retrievalId Retrieval ID associated with this media capture request. Examples: 2308cec4-82e0-46f1-8b3c-a3592e5cc21e
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMediaRetrieval(retrievalId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This endpoint will return all speeding intervals associated with trips that have been collected for your organization based on the time parameters passed in. Only completed trips are included. 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.
* @summary [beta] Get Speeding Intervals
* @param {Array} assetIds Comma-separated list of asset IDs. Include up to 50 asset IDs.
* @param {string} startTime RFC 3339 timestamp that indicates when to begin receiving data. Value is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter.
* @param {string} [endTime] RFC 3339 timestamp which is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter. If not provided then the endpoint behaves as an unending feed of changes.
* @param {GetSpeedingIntervalsQueryByEnum} [queryBy] Decide which timestamp the `startTime` and `endTime` are compared to. Valid values: `updatedAtTime`, `tripStartTime`
* @param {boolean} [includeAsset] Indicates whether or not to return expanded “asset” data
* @param {boolean} [includeDriverId] Indicates whether or not to return trip\'s driver id
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [severityLevels] Optional string of comma-separated severity levels to filter speeding intervals by. Valid values: “light”, ”moderate”, ”heavy”, “severe”.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSpeedingIntervals(assetIds: Array, startTime: string, endTime?: string, queryBy?: GetSpeedingIntervalsQueryByEnum, includeAsset?: boolean, includeDriverId?: boolean, after?: string, severityLevels?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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. 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.
* @summary [beta] Get trailer stats feed
* @param {string} types The stat types you want this endpoint to return information on. You may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [trailerIds] A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} [decorations] Decorations add to the primary stats listed in the `types` parameter. For example, if you wish to know the trailer\'s location whenever the odometer updates, you may set `types=gpsOdometerMeters&decorations=gps`. You may list **up to 2** types using comma-separated format. If multiple stats are listed in the types parameter, the decorations will be added to each type. For example: `types=reeferStateZone1,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters&decorations=gps` will list GPS decorations for each reeferStateZone1 reading, each reeferAmbientAirTemperatureMilliC reding, and gpsOdometerMeters reading. Note that decorations may significantly increase the response payload size. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrailerStatsFeed(types: string, tagIds?: string, parentTagIds?: string, after?: string, trailerIds?: string, decorations?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Get trailer stats history
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} types The stat types you want this endpoint to return information on. You may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [trailerIds] A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} [decorations] Decorations add to the primary stats listed in the `types` parameter. For example, if you wish to know the trailer\'s location whenever the odometer updates, you may set `types=gpsOdometerMeters&decorations=gps`. You may list **up to 2** types using comma-separated format. If multiple stats are listed in the types parameter, the decorations will be added to each type. For example: `types=reeferStateZone1,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters&decorations=gps` will list GPS decorations for each reeferStateZone1 reading, each reeferAmbientAirTemperatureMilliC reding, and gpsOdometerMeters reading. Note that decorations may significantly increase the response payload size. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrailerStatsHistory(startTime: string, endTime: string, types: string, tagIds?: string, parentTagIds?: string, after?: string, trailerIds?: string, decorations?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Get trailer stats
* @param {string} types The stat types you want this endpoint to return information on. You may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`. * `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address. * `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered. * `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius. * `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions. * `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions. * `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions. * `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions. * `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions. * `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions. * `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`) * `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions. * `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions. * `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone. * `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions. * `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [trailerIds] A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} [time] A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 Format. Millisecond precision and timezones are supported.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrailerStatsSnapshot(types: string, tagIds?: string, parentTagIds?: string, after?: string, trailerIds?: string, time?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization. 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.
* @summary [beta] Get a stream of filtered training assignments.
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [learnerIds] Optional string of comma separated learner IDs. If learner ID is present, training assignments for the specified learner(s) will be returned. Max value for this value is 100 objects. Example: `learnerIds=driver-281474,driver-46282156`
* @param {Array} [courseIds] Optional string of comma separated course IDs. If course ID is present, training assignments for the specified course ID(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `courseIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {Array} [status] Optional string of comma separated values. If status is present, training assignments for the specified status(s) will be returned. Valid values: \"notStarted\", \"inProgress\", \"completed\". Defaults to returning all courses.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrainingAssignmentsStream(startTime: string, after?: string, endTime?: string, learnerIds?: Array, courseIds?: Array, status?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Get a list of filtered training courses.
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {Array} [courseIds] Optional string of comma separated course IDs. If course ID is present, training assignments for the specified course ID(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `courseIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {Array} [categoryIds] Optional string of comma separated course category IDs. If courseCategoryId is present, training courses for the specified course category(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `categoryIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {Array} [status] Optional string of comma separated values. If status is present, training courses with the specified status(s) will be returned. Valid values: “published”, “deleted”, “archived”. Defaults to returning all courses.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrainingCourses(after?: string, courseIds?: Array, categoryIds?: Array, status?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This endpoint will return trips that have been collected for your organization based on the time parameters passed in. Results are paginated. Reach out to your Samsara Representative to have this API enabled for your organization. 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.
* @summary [beta] Get trips
* @param {string} startTime RFC 3339 timestamp that indicates when to begin receiving data. Value is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter.
* @param {Array} ids Comma-separated list of asset IDs. Include up to 50 asset IDs.
* @param {boolean} [includeAsset] Indicates whether or not to return expanded “asset” data
* @param {GetTripsCompletionStatusEnum} [completionStatus] Filters trips based on a specific completion status Valid values: `inProgress`, `completed`, `all`
* @param {string} [endTime] RFC 3339 timestamp which is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter. If not provided then the endpoint behaves as an unending feed of changes.
* @param {GetTripsQueryByEnum} [queryBy] Decide which timestamp the `startTime` and `endTime` are compared to. Valid values: `updatedAtTime`, `tripStartTime`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTrips(startTime: string, ids: Array, includeAsset?: boolean, completionStatus?: GetTripsCompletionStatusEnum, endTime?: string, queryBy?: GetTripsQueryByEnum, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] List all assets.
* @param {ListAssetsTypeEnum} [type] The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [updatedAfterTime] A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {boolean} [includeExternalIds] Optional boolean indicating whether to return external IDs on supported entities
* @param {boolean} [includeTags] Optional boolean indicating whether to return tags on supported entities
* @param {string} [tagIds] A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @param {string} [parentTagIds] A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`
* @param {Array} [ids] A filter on the data based on this comma-separated list of asset IDs and External IDs.
* @param {string} [attributeValueIds] A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listAssets(type?: ListAssetsTypeEnum, after?: string, updatedAfterTime?: string, includeExternalIds?: boolean, includeTags?: boolean, tagIds?: string, parentTagIds?: string, ids?: Array, attributeValueIds?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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: 100 requests/min (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.
* @summary [beta] List uploaded media by time range.
* @param {string} vehicleIds A filter on the data based on this comma-separated list of vehicle IDs and externalIds. You can specify up to 20 vehicles. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @param {string} startTime A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. End time cannot be more than 24 hours after startTime. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [inputs] An optional list of desired camera inputs for which to return captured media. If empty, media for all available inputs will be returned. Possible options include: dashcamRoadFacing, dashcamDriverFacing, analog.
* @param {Array} [mediaTypes] An optional list of desired media types for which to return captured media. If empty, media for all available media types will be returned. Possible options include: IMAGE, VIDEO_HIGH_RES.
* @param {Array} [triggerReasons] An optional list of desired trigger reasons for which to return captured media. If empty, media for all available trigger reasons will be returned. Possible options include: api, panicButton, periodicStill, safetyEvent, tripEndStill, tripStartStill, videoRetrieval. videoRetrieval represents media captured for a dashboard video retrieval request.
* @param {string} [availableAfterTime] An optional timestamp in RFC 3339 format that can act as a cursor to track which media has previously been retrieved; only media whose availableAtTime comes after this parameter will be returned. Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listUploadedMedia(vehicleIds: string, startTime: string, endTime: string, inputs?: Array, mediaTypes?: Array, triggerReasons?: Array, availableAfterTime?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Update an equipment
* @param {string} id The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed.
* @param {EquipmentPatchEquipmentRequestBody} patchEquipmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchEquipment(id: string, patchEquipmentRequestBody: EquipmentPatchEquipmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Updates an instance of a form submission. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Form Submissions** 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.
* @summary [beta] Update a single form submission.
* @param {FormSubmissionsPatchFormSubmissionRequestBody} patchFormSubmissionRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchFormSubmission(patchFormSubmissionRequestBody: FormSubmissionsPatchFormSubmissionRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Updates an instance of an issue. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Issues** 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.
* @summary [beta] Update a single issue.
* @param {IssuesPatchIssueRequestBody} patchIssueRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchIssue(patchIssueRequestBody: IssuesPatchIssueRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Patches a job
* @param {string} id A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`).
* @param {JobsPatchJobRequestBody} patchJobRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchJob(id: string, patchJobRequestBody: JobsPatchJobRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update training assignments. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization. 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.
* @summary [beta] Update training assignments.
* @param {Array} ids String of comma separated assignments IDs. Max value for this value is 100 objects .Example: `ids=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`
* @param {string} dueAtTime Due date of the training assignment in RFC 3339 format. Millisecond precision and timezones are supported.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchTrainingAssignments(ids: Array, dueAtTime: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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 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.
* @summary [beta] Sign out a driver
* @param {DriverRemoteSignoutPostDriverRemoteSignoutRequestBody} postDriverRemoteSignoutRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postDriverRemoteSignout(postDriverRemoteSignoutRequestBody: DriverRemoteSignoutPostDriverRemoteSignoutRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Creates a form submission. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Form Submissions** 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.
* @summary [beta] Create a form submission.
* @param {FormSubmissionsPostFormSubmissionRequestBody} postFormSubmissionRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postFormSubmission(postFormSubmissionRequestBody: FormSubmissionsPostFormSubmissionRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Creates a PDF export for a form submission. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Form Submissions** 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.
* @summary [beta] Create a PDF export for a form submission.
* @param {string} id ID of the form submission to create a PDF export from.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postFormSubmissionsPdfExports(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This endpoint creates an asynchronous request to upload certain media from a device. The closest available media to the requested timestamp is returned. Images and high-res videos are supported; other types of media (e.g. hyperlapse, low-res) are planned to be supported in the future. Currently, only unblurred media is supported. If a device is offline, the requested media will be uploaded once it comes back online. Quota limits for media requests will be enforced in GA, but not in closed beta. 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.
* @summary [beta] Create a media retrieval request
* @param {MediaRetrievalPostMediaRetrievalRequestBody} postMediaRetrievalRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postMediaRetrieval(postMediaRetrievalRequestBody: MediaRetrievalPostMediaRetrievalRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Create training assignments. Existing assignments will remain unchanged. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization. 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.
* @summary [beta] Create training assignments.
* @param {string} courseId String for the course ID.
* @param {string} dueAtTime Due date of the training assignment in RFC 3339 format. Millisecond precision and timezones are supported.
* @param {Array} learnerIds Optional string of comma separated learner IDs. If learner ID is present, training assignments for the specified learner(s) will be returned. Max value for this value is 100 objects. Example: `learnerIds=driver-281474,driver-46282156`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postTrainingAssignments(courseId: string, dueAtTime: string, learnerIds: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Update an existing asset.
* @param {string} id A filter selecting a single asset by id.
* @param {AssetsUpdateAssetRequestBody} updateAssetRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateAsset(id: string, updateAssetRequestBody: AssetsUpdateAssetRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Update an existing driver-trailer assignment.
* @param {string} id Samsara ID for the assignment.
* @param {TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody} updateDriverTrailerAssignmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDriverTrailerAssignment(id: string, updateDriverTrailerAssignmentRequestBody: TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Update engine immobilizer state of a vehicle.
* @param {number} id Vehicle ID
* @param {EngineImmobilizerUpdateEngineImmobilizerStateRequestBody} updateEngineImmobilizerStateRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateEngineImmobilizerState(id: number, updateEngineImmobilizerStateRequestBody: EngineImmobilizerUpdateEngineImmobilizerStateRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* 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.
* @summary [beta] Update the shippingDocs field of an existing assignment.
* @param {string} hosDate A start date in yyyy-mm-dd format. Required.
* @param {string} driverID ID of the driver for whom the duty status is being set.
* @param {HosDailyLogsUpdateShippingDocsRequestBody} updateShippingDocsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateShippingDocs(hosDate: string, driverID: string, updateShippingDocsRequestBody: HosDailyLogsUpdateShippingDocsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* BetaAPIsApi - factory interface
* @export
*/
export declare const BetaAPIsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* 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.
* @summary [beta] Create a new asset.
* @param {BetaAPIsApiCreateAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createAsset(requestParameters: BetaAPIsApiCreateAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary [beta] Create a new driver-trailer assignment
* @param {BetaAPIsApiCreateDriverTrailerAssignmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDriverTrailerAssignment(requestParameters: BetaAPIsApiCreateDriverTrailerAssignmentRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary [beta] Create a job
* @param {BetaAPIsApiCreateJobRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createJob(requestParameters: BetaAPIsApiCreateJobRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary [beta] Delete an existing asset.
* @param {BetaAPIsApiDeleteAssetRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteAsset(requestParameters: BetaAPIsApiDeleteAssetRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary [beta] Deletes an existing job
* @param {BetaAPIsApiDeleteJobRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteJob(requestParameters: BetaAPIsApiDeleteJobRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization. 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.
* @summary [beta] Delete training assignments.
* @param {BetaAPIsApiDeleteTrainingAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteTrainingAssignments(requestParameters: BetaAPIsApiDeleteTrainingAssignmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary [beta] Get a list of AEMP equipment
* @param {BetaAPIsApiGetAempEquipmentListRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAempEquipmentList(requestParameters: BetaAPIsApiGetAempEquipmentListRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary [beta] List asset inputs data in an organization.
* @param {BetaAPIsApiGetAssetsInputsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAssetsInputs(requestParameters: BetaAPIsApiGetAssetsInputsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns all installed cameras (CM3x), vehicle gateways (VGs), and asset gateways (AGs) 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.
* @summary [beta] List devices.
* @param {BetaAPIsApiGetDevicesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDevices(requestParameters?: BetaAPIsApiGetDevicesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get all driver and associated vehicle efficiency data. 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.
* @summary [beta] List driver efficiency
* @param {BetaAPIsApiGetDriverEfficiencyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverEfficiency(requestParameters?: BetaAPIsApiGetDriverEfficiencyRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary [beta] Get currently active driver-trailer assignments for driver.
* @param {BetaAPIsApiGetDriverTrailerAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverTrailerAssignments(requestParameters: BetaAPIsApiGetDriverTrailerAssignmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* 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.
* @summary [beta] Get engine immobilizer states
* @param {BetaAPIsApiGetEngineImmobilizerStatesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getEngineImmobilizerStates(requestParameters: BetaAPIsApiGetEngineImmobilizerStatesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns all form submissions data for the specified IDs. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Form Submissions** 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.
* @summary [beta] Get a list of specified form submissions.
* @param {BetaAPIsApiGetFormSubmissionsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFormSubmissions(requestParameters: BetaAPIsApiGetFormSubmissionsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a PDF export for a form submission. **Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.