/**
* 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 { CustomReportsGetCustomReportConfigsResponseBody } from '../samsara-models';
import { CustomReportsGetCustomReportRunDataResponseBody } from '../samsara-models';
import { CustomReportsGetCustomReportRunsResponseBody } from '../samsara-models';
import { CustomReportsPostCustomReportRunRequestBody } from '../samsara-models';
import { CustomReportsPostCustomReportRunResponseBody } from '../samsara-models';
import { DriverEfficiencyGetDriverEfficiencyByDriversResponseBody } from '../samsara-models';
import { DriverEfficiencyGetDriverEfficiencyByVehiclesResponseBody } from '../samsara-models';
import { FormTemplatesGetFormTemplatesResponseBody } from '../samsara-models';
import { WorkOrdersGetServiceTasksResponseBody } from '../samsara-models';
import { WorkOrdersGetWorkOrdersResponseBody } from '../samsara-models';
import { WorkOrdersPatchWorkOrdersRequestBody } from '../samsara-models';
import { WorkOrdersPatchWorkOrdersResponseBody } from '../samsara-models';
import { WorkOrdersPostWorkOrdersRequestBody } from '../samsara-models';
import { WorkOrdersPostWorkOrdersResponseBody } from '../samsara-models';
import { WorkOrdersStreamWorkOrdersResponseBody } from '../samsara-models';
/**
* PreviewAPIsApi - axios parameter creator
* @export
*/
export declare const PreviewAPIsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Deletes a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Deletes a work order.
* @param {string} id The unique id of the work order.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWorkOrders: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get paginated custom report configs created in the organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report configs
* @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 reports will be in the response. Default and max for this value is 100 objects.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCustomReportConfigs: (after?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* This endpoint will return the custom report data for a given custom report run ID. For more information regarding custom report columns, please see our [KB article section on Custom Report Fields](https://kb.samsara.com/hc/en-us/articles/360052711232-Manage-Custom-Reports). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report run data
* @param {string} [id] The ID of the specified run for the requested custom report.
* @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}
*/
getCustomReportRunData: (id?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get all custom report runs with the provided IDs or customReportIds. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report runs
* @param {Array} [customReportIds] Required array of custom report IDs for the custom report runs wanted. Only one of customReportIds or ids is allowed.
* @param {Array} [ids] Required array of custom report run IDs to fetch. Only one of ids or customReportIds is allowed.
* @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}
*/
getCustomReportRuns: (customReportIds?: Array, ids?: Array, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This endpoint will return driver efficiency data that has been collected for your organization and grouped by drivers based on the time parameters passed in. Results are paginated. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get Driver efficiency data grouped by drivers.
* @param {string} startTime A start time in RFC 3339 format. Must be in multiple of hours and at least 1 day before endTime. Timezones are supported. 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. (Examples: 2019-06-11T19:00:00Z, 2015-09-12T14:00:00-04:00).
* @param {string} endTime An end time in RFC 3339 format. Must be in multiple of hours and no later than 3 hours before the current time. Timezones are supported. 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. (Examples: 2019-06-13T19:00:00Z, 2015-09-15T14:00:00-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 {Array} [dataFormats] A comma-separated list of data formats you want to fetch. Valid values: `score`, `raw` and `percentage`. The default data format is `score`. Example: `dataFormats=raw,score`
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverEfficiencyByDrivers: (startTime: string, endTime: string, driverIds?: Array, dataFormats?: Array, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This endpoint will return driver efficiency data that has been collected for your organization and grouped by vehicle drivers used based on the time parameters passed in. Results are paginated. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get Driver efficiency data grouped by vehicles.
* @param {string} startTime A start time in RFC 3339 format. Must be in multiple of hours and at least 1 day before endTime. Timezones are supported. 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. (Examples: 2019-06-11T19:00:00Z, 2015-09-12T14:00:00-04:00).
* @param {string} endTime An end time in RFC 3339 format. Must be in multiple of hours and no later than 3 hours before the current time. Timezones are supported. 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. (Examples: 2019-06-13T19:00:00Z, 2015-09-15T14:00:00-04:00).
* @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 {Array} [dataFormats] A comma-separated list of data formats you want to fetch. Valid values: `score`, `raw` and `percentage`. The default data format is `score`. Example: `dataFormats=raw,score`
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverEfficiencyByVehicles: (startTime: string, endTime: string, vehicleIds?: string, dataFormats?: Array, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a list of the organization\'s form templates. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Preview** under the category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get a list of form templates.
* @param {Array} [ids] A comma-separated list containing up to 100 template IDs to filter on.
* @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}
*/
getFormTemplates: (ids?: Array, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Gets service tasks. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Gets service tasks.
* @param {Array} [ids] Filter by the IDs. If not provided, won\'t filter by id.
* @param {boolean} [includeArchived] Include archived service task definitions.
* @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}
*/
getServiceTasks: (ids?: Array, includeArchived?: boolean, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Gets work orders. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Gets work orders.
* @param {Array} [ids] Filter by the IDs. Up to 100 ids. Returns all if no ids are provided.
* @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}
*/
getWorkOrders: (ids?: Array, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Updates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Updates a work order.
* @param {WorkOrdersPatchWorkOrdersRequestBody} patchWorkOrdersRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchWorkOrders: (patchWorkOrdersRequestBody: WorkOrdersPatchWorkOrdersRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Create a custom report run which then gets queued up to generate custom report data for the report run. Rate limit: 240 requests/day (learn more about rate limits here). To use this endpoint, select **Write Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Create a custom report run
* @param {CustomReportsPostCustomReportRunRequestBody} postCustomReportRunRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postCustomReportRun: (postCustomReportRunRequestBody: CustomReportsPostCustomReportRunRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Creates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Creates a work order.
* @param {WorkOrdersPostWorkOrdersRequestBody} postWorkOrdersRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postWorkOrders: (postWorkOrdersRequestBody: WorkOrdersPostWorkOrdersRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Stream work orders. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Stream work orders.
* @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 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} [workOrderStatuses] Work Order status filter.
* @param {Array} [assetIds] Work Order asset id filter. Up to 50 ids.
* @param {Array} [assignedUserIds] Work Order assigned user id filter. Up to 50 ids.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
streamWorkOrders: (startTime: string, after?: string, endTime?: string, workOrderStatuses?: Array, assetIds?: Array, assignedUserIds?: Array, options?: RawAxiosRequestConfig) => Promise;
};
/**
* PreviewAPIsApi - functional programming interface
* @export
*/
export declare const PreviewAPIsApiFp: (configuration?: Configuration) => {
/**
* Deletes a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Deletes a work order.
* @param {string} id The unique id of the work order.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWorkOrders(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get paginated custom report configs created in the organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report configs
* @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 reports will be in the response. Default and max for this value is 100 objects.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCustomReportConfigs(after?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This endpoint will return the custom report data for a given custom report run ID. For more information regarding custom report columns, please see our [KB article section on Custom Report Fields](https://kb.samsara.com/hc/en-us/articles/360052711232-Manage-Custom-Reports). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report run data
* @param {string} [id] The ID of the specified run for the requested custom report.
* @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}
*/
getCustomReportRunData(id?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get all custom report runs with the provided IDs or customReportIds. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report runs
* @param {Array} [customReportIds] Required array of custom report IDs for the custom report runs wanted. Only one of customReportIds or ids is allowed.
* @param {Array} [ids] Required array of custom report run IDs to fetch. Only one of ids or customReportIds is allowed.
* @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}
*/
getCustomReportRuns(customReportIds?: Array, ids?: Array, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This endpoint will return driver efficiency data that has been collected for your organization and grouped by drivers based on the time parameters passed in. Results are paginated. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get Driver efficiency data grouped by drivers.
* @param {string} startTime A start time in RFC 3339 format. Must be in multiple of hours and at least 1 day before endTime. Timezones are supported. 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. (Examples: 2019-06-11T19:00:00Z, 2015-09-12T14:00:00-04:00).
* @param {string} endTime An end time in RFC 3339 format. Must be in multiple of hours and no later than 3 hours before the current time. Timezones are supported. 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. (Examples: 2019-06-13T19:00:00Z, 2015-09-15T14:00:00-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 {Array} [dataFormats] A comma-separated list of data formats you want to fetch. Valid values: `score`, `raw` and `percentage`. The default data format is `score`. Example: `dataFormats=raw,score`
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverEfficiencyByDrivers(startTime: string, endTime: string, driverIds?: Array, dataFormats?: Array, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This endpoint will return driver efficiency data that has been collected for your organization and grouped by vehicle drivers used based on the time parameters passed in. Results are paginated. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get Driver efficiency data grouped by vehicles.
* @param {string} startTime A start time in RFC 3339 format. Must be in multiple of hours and at least 1 day before endTime. Timezones are supported. 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. (Examples: 2019-06-11T19:00:00Z, 2015-09-12T14:00:00-04:00).
* @param {string} endTime An end time in RFC 3339 format. Must be in multiple of hours and no later than 3 hours before the current time. Timezones are supported. 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. (Examples: 2019-06-13T19:00:00Z, 2015-09-15T14:00:00-04:00).
* @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 {Array} [dataFormats] A comma-separated list of data formats you want to fetch. Valid values: `score`, `raw` and `percentage`. The default data format is `score`. Example: `dataFormats=raw,score`
* @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 {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverEfficiencyByVehicles(startTime: string, endTime: string, vehicleIds?: string, dataFormats?: Array, tagIds?: string, parentTagIds?: string, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a list of the organization\'s form templates. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Preview** under the category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get a list of form templates.
* @param {Array} [ids] A comma-separated list containing up to 100 template IDs to filter on.
* @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}
*/
getFormTemplates(ids?: Array, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Gets service tasks. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Gets service tasks.
* @param {Array} [ids] Filter by the IDs. If not provided, won\'t filter by id.
* @param {boolean} [includeArchived] Include archived service task definitions.
* @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}
*/
getServiceTasks(ids?: Array, includeArchived?: boolean, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Gets work orders. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Gets work orders.
* @param {Array} [ids] Filter by the IDs. Up to 100 ids. Returns all if no ids are provided.
* @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}
*/
getWorkOrders(ids?: Array, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Updates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Updates a work order.
* @param {WorkOrdersPatchWorkOrdersRequestBody} patchWorkOrdersRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchWorkOrders(patchWorkOrdersRequestBody: WorkOrdersPatchWorkOrdersRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Create a custom report run which then gets queued up to generate custom report data for the report run. Rate limit: 240 requests/day (learn more about rate limits here). To use this endpoint, select **Write Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Create a custom report run
* @param {CustomReportsPostCustomReportRunRequestBody} postCustomReportRunRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postCustomReportRun(postCustomReportRunRequestBody: CustomReportsPostCustomReportRunRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Creates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Creates a work order.
* @param {WorkOrdersPostWorkOrdersRequestBody} postWorkOrdersRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postWorkOrders(postWorkOrdersRequestBody: WorkOrdersPostWorkOrdersRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Stream work orders. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Stream work orders.
* @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 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} [workOrderStatuses] Work Order status filter.
* @param {Array} [assetIds] Work Order asset id filter. Up to 50 ids.
* @param {Array} [assignedUserIds] Work Order assigned user id filter. Up to 50 ids.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
streamWorkOrders(startTime: string, after?: string, endTime?: string, workOrderStatuses?: Array, assetIds?: Array, assignedUserIds?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* PreviewAPIsApi - factory interface
* @export
*/
export declare const PreviewAPIsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Deletes a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Deletes a work order.
* @param {PreviewAPIsApiDeleteWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWorkOrders(requestParameters: PreviewAPIsApiDeleteWorkOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get paginated custom report configs created in the organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report configs
* @param {PreviewAPIsApiGetCustomReportConfigsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCustomReportConfigs(requestParameters?: PreviewAPIsApiGetCustomReportConfigsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This endpoint will return the custom report data for a given custom report run ID. For more information regarding custom report columns, please see our [KB article section on Custom Report Fields](https://kb.samsara.com/hc/en-us/articles/360052711232-Manage-Custom-Reports). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report run data
* @param {PreviewAPIsApiGetCustomReportRunDataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCustomReportRunData(requestParameters?: PreviewAPIsApiGetCustomReportRunDataRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get all custom report runs with the provided IDs or customReportIds. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report runs
* @param {PreviewAPIsApiGetCustomReportRunsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCustomReportRuns(requestParameters?: PreviewAPIsApiGetCustomReportRunsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This endpoint will return driver efficiency data that has been collected for your organization and grouped by drivers based on the time parameters passed in. Results are paginated. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get Driver efficiency data grouped by drivers.
* @param {PreviewAPIsApiGetDriverEfficiencyByDriversRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverEfficiencyByDrivers(requestParameters: PreviewAPIsApiGetDriverEfficiencyByDriversRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This endpoint will return driver efficiency data that has been collected for your organization and grouped by vehicle drivers used based on the time parameters passed in. Results are paginated. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get Driver efficiency data grouped by vehicles.
* @param {PreviewAPIsApiGetDriverEfficiencyByVehiclesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverEfficiencyByVehicles(requestParameters: PreviewAPIsApiGetDriverEfficiencyByVehiclesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of the organization\'s form templates. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Preview** under the category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get a list of form templates.
* @param {PreviewAPIsApiGetFormTemplatesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFormTemplates(requestParameters?: PreviewAPIsApiGetFormTemplatesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Gets service tasks. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Gets service tasks.
* @param {PreviewAPIsApiGetServiceTasksRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getServiceTasks(requestParameters?: PreviewAPIsApiGetServiceTasksRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Gets work orders. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Gets work orders.
* @param {PreviewAPIsApiGetWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWorkOrders(requestParameters?: PreviewAPIsApiGetWorkOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Updates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Updates a work order.
* @param {PreviewAPIsApiPatchWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchWorkOrders(requestParameters: PreviewAPIsApiPatchWorkOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Create a custom report run which then gets queued up to generate custom report data for the report run. Rate limit: 240 requests/day (learn more about rate limits here). To use this endpoint, select **Write Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Create a custom report run
* @param {PreviewAPIsApiPostCustomReportRunRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postCustomReportRun(requestParameters: PreviewAPIsApiPostCustomReportRunRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Creates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Creates a work order.
* @param {PreviewAPIsApiPostWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postWorkOrders(requestParameters: PreviewAPIsApiPostWorkOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Stream work orders. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Stream work orders.
* @param {PreviewAPIsApiStreamWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
streamWorkOrders(requestParameters: PreviewAPIsApiStreamWorkOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteWorkOrders operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiDeleteWorkOrdersRequest
*/
export interface PreviewAPIsApiDeleteWorkOrdersRequest {
/**
* The unique id of the work order.
* @type {string}
* @memberof PreviewAPIsApiDeleteWorkOrders
*/
readonly id: string;
}
/**
* Request parameters for getCustomReportConfigs operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiGetCustomReportConfigsRequest
*/
export interface PreviewAPIsApiGetCustomReportConfigsRequest {
/**
* 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.
* @type {string}
* @memberof PreviewAPIsApiGetCustomReportConfigs
*/
readonly after?: string;
/**
* The limit for how many reports will be in the response. Default and max for this value is 100 objects.
* @type {number}
* @memberof PreviewAPIsApiGetCustomReportConfigs
*/
readonly limit?: number;
}
/**
* Request parameters for getCustomReportRunData operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiGetCustomReportRunDataRequest
*/
export interface PreviewAPIsApiGetCustomReportRunDataRequest {
/**
* The ID of the specified run for the requested custom report.
* @type {string}
* @memberof PreviewAPIsApiGetCustomReportRunData
*/
readonly id?: string;
/**
* 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.
* @type {string}
* @memberof PreviewAPIsApiGetCustomReportRunData
*/
readonly after?: string;
}
/**
* Request parameters for getCustomReportRuns operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiGetCustomReportRunsRequest
*/
export interface PreviewAPIsApiGetCustomReportRunsRequest {
/**
* Required array of custom report IDs for the custom report runs wanted. Only one of customReportIds or ids is allowed.
* @type {Array}
* @memberof PreviewAPIsApiGetCustomReportRuns
*/
readonly customReportIds?: Array;
/**
* Required array of custom report run IDs to fetch. Only one of ids or customReportIds is allowed.
* @type {Array}
* @memberof PreviewAPIsApiGetCustomReportRuns
*/
readonly ids?: Array;
/**
* 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.
* @type {string}
* @memberof PreviewAPIsApiGetCustomReportRuns
*/
readonly after?: string;
}
/**
* Request parameters for getDriverEfficiencyByDrivers operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiGetDriverEfficiencyByDriversRequest
*/
export interface PreviewAPIsApiGetDriverEfficiencyByDriversRequest {
/**
* A start time in RFC 3339 format. Must be in multiple of hours and at least 1 day before endTime. Timezones are supported. 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. (Examples: 2019-06-11T19:00:00Z, 2015-09-12T14:00:00-04:00).
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByDrivers
*/
readonly startTime: string;
/**
* An end time in RFC 3339 format. Must be in multiple of hours and no later than 3 hours before the current time. Timezones are supported. 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. (Examples: 2019-06-13T19:00:00Z, 2015-09-15T14:00:00-04:00).
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByDrivers
*/
readonly endTime: string;
/**
* A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @type {Array}
* @memberof PreviewAPIsApiGetDriverEfficiencyByDrivers
*/
readonly driverIds?: Array;
/**
* A comma-separated list of data formats you want to fetch. Valid values: `score`, `raw` and `percentage`. The default data format is `score`. Example: `dataFormats=raw,score`
* @type {Array}
* @memberof PreviewAPIsApiGetDriverEfficiencyByDrivers
*/
readonly dataFormats?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByDrivers
*/
readonly tagIds?: string;
/**
* 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`
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByDrivers
*/
readonly parentTagIds?: string;
/**
* 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.
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByDrivers
*/
readonly after?: string;
}
/**
* Request parameters for getDriverEfficiencyByVehicles operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiGetDriverEfficiencyByVehiclesRequest
*/
export interface PreviewAPIsApiGetDriverEfficiencyByVehiclesRequest {
/**
* A start time in RFC 3339 format. Must be in multiple of hours and at least 1 day before endTime. Timezones are supported. 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. (Examples: 2019-06-11T19:00:00Z, 2015-09-12T14:00:00-04:00).
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByVehicles
*/
readonly startTime: string;
/**
* An end time in RFC 3339 format. Must be in multiple of hours and no later than 3 hours before the current time. Timezones are supported. 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. (Examples: 2019-06-13T19:00:00Z, 2015-09-15T14:00:00-04:00).
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByVehicles
*/
readonly endTime: string;
/**
* A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByVehicles
*/
readonly vehicleIds?: string;
/**
* A comma-separated list of data formats you want to fetch. Valid values: `score`, `raw` and `percentage`. The default data format is `score`. Example: `dataFormats=raw,score`
* @type {Array}
* @memberof PreviewAPIsApiGetDriverEfficiencyByVehicles
*/
readonly dataFormats?: Array;
/**
* A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByVehicles
*/
readonly tagIds?: string;
/**
* 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`
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByVehicles
*/
readonly parentTagIds?: string;
/**
* 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.
* @type {string}
* @memberof PreviewAPIsApiGetDriverEfficiencyByVehicles
*/
readonly after?: string;
}
/**
* Request parameters for getFormTemplates operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiGetFormTemplatesRequest
*/
export interface PreviewAPIsApiGetFormTemplatesRequest {
/**
* A comma-separated list containing up to 100 template IDs to filter on.
* @type {Array}
* @memberof PreviewAPIsApiGetFormTemplates
*/
readonly ids?: Array;
/**
* 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.
* @type {string}
* @memberof PreviewAPIsApiGetFormTemplates
*/
readonly after?: string;
}
/**
* Request parameters for getServiceTasks operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiGetServiceTasksRequest
*/
export interface PreviewAPIsApiGetServiceTasksRequest {
/**
* Filter by the IDs. If not provided, won\'t filter by id.
* @type {Array}
* @memberof PreviewAPIsApiGetServiceTasks
*/
readonly ids?: Array;
/**
* Include archived service task definitions.
* @type {boolean}
* @memberof PreviewAPIsApiGetServiceTasks
*/
readonly includeArchived?: boolean;
/**
* 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.
* @type {string}
* @memberof PreviewAPIsApiGetServiceTasks
*/
readonly after?: string;
}
/**
* Request parameters for getWorkOrders operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiGetWorkOrdersRequest
*/
export interface PreviewAPIsApiGetWorkOrdersRequest {
/**
* Filter by the IDs. Up to 100 ids. Returns all if no ids are provided.
* @type {Array}
* @memberof PreviewAPIsApiGetWorkOrders
*/
readonly ids?: Array;
/**
* 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.
* @type {string}
* @memberof PreviewAPIsApiGetWorkOrders
*/
readonly after?: string;
}
/**
* Request parameters for patchWorkOrders operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiPatchWorkOrdersRequest
*/
export interface PreviewAPIsApiPatchWorkOrdersRequest {
/**
*
* @type {WorkOrdersPatchWorkOrdersRequestBody}
* @memberof PreviewAPIsApiPatchWorkOrders
*/
readonly patchWorkOrdersRequestBody: WorkOrdersPatchWorkOrdersRequestBody;
}
/**
* Request parameters for postCustomReportRun operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiPostCustomReportRunRequest
*/
export interface PreviewAPIsApiPostCustomReportRunRequest {
/**
*
* @type {CustomReportsPostCustomReportRunRequestBody}
* @memberof PreviewAPIsApiPostCustomReportRun
*/
readonly postCustomReportRunRequestBody: CustomReportsPostCustomReportRunRequestBody;
}
/**
* Request parameters for postWorkOrders operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiPostWorkOrdersRequest
*/
export interface PreviewAPIsApiPostWorkOrdersRequest {
/**
*
* @type {WorkOrdersPostWorkOrdersRequestBody}
* @memberof PreviewAPIsApiPostWorkOrders
*/
readonly postWorkOrdersRequestBody: WorkOrdersPostWorkOrdersRequestBody;
}
/**
* Request parameters for streamWorkOrders operation in PreviewAPIsApi.
* @export
* @interface PreviewAPIsApiStreamWorkOrdersRequest
*/
export interface PreviewAPIsApiStreamWorkOrdersRequest {
/**
* 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).
* @type {string}
* @memberof PreviewAPIsApiStreamWorkOrders
*/
readonly startTime: string;
/**
* 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.
* @type {string}
* @memberof PreviewAPIsApiStreamWorkOrders
*/
readonly after?: string;
/**
* 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).
* @type {string}
* @memberof PreviewAPIsApiStreamWorkOrders
*/
readonly endTime?: string;
/**
* Work Order status filter.
* @type {Array<'ASSIGNED' | 'CANCELLED' | 'CLOSED' | 'COMPLETED' | 'IN_PROGRESS' | 'ON_HOLD' | 'OPEN' | 'PENDING_APPROVAL' | 'PENDING_PARTS'>}
* @memberof PreviewAPIsApiStreamWorkOrders
*/
readonly workOrderStatuses?: Array;
/**
* Work Order asset id filter. Up to 50 ids.
* @type {Array}
* @memberof PreviewAPIsApiStreamWorkOrders
*/
readonly assetIds?: Array;
/**
* Work Order assigned user id filter. Up to 50 ids.
* @type {Array}
* @memberof PreviewAPIsApiStreamWorkOrders
*/
readonly assignedUserIds?: Array;
}
/**
* PreviewAPIsApi - object-oriented interface
* @export
* @class PreviewAPIsApi
* @extends {BaseAPI}
*/
export declare class PreviewAPIsApi extends BaseAPI {
/**
* Deletes a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Deletes a work order.
* @param {PreviewAPIsApiDeleteWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
deleteWorkOrders(requestParameters: PreviewAPIsApiDeleteWorkOrdersRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get paginated custom report configs created in the organization. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report configs
* @param {PreviewAPIsApiGetCustomReportConfigsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
getCustomReportConfigs(requestParameters?: PreviewAPIsApiGetCustomReportConfigsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This endpoint will return the custom report data for a given custom report run ID. For more information regarding custom report columns, please see our [KB article section on Custom Report Fields](https://kb.samsara.com/hc/en-us/articles/360052711232-Manage-Custom-Reports). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report run data
* @param {PreviewAPIsApiGetCustomReportRunDataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
getCustomReportRunData(requestParameters?: PreviewAPIsApiGetCustomReportRunDataRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get all custom report runs with the provided IDs or customReportIds. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get custom report runs
* @param {PreviewAPIsApiGetCustomReportRunsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
getCustomReportRuns(requestParameters?: PreviewAPIsApiGetCustomReportRunsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This endpoint will return driver efficiency data that has been collected for your organization and grouped by drivers based on the time parameters passed in. Results are paginated. Rate limit: 10 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get Driver efficiency data grouped by drivers.
* @param {PreviewAPIsApiGetDriverEfficiencyByDriversRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
getDriverEfficiencyByDrivers(requestParameters: PreviewAPIsApiGetDriverEfficiencyByDriversRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This endpoint will return driver efficiency data that has been collected for your organization and grouped by vehicle drivers used based on the time parameters passed in. Results are paginated. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get Driver efficiency data grouped by vehicles.
* @param {PreviewAPIsApiGetDriverEfficiencyByVehiclesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
getDriverEfficiencyByVehicles(requestParameters: PreviewAPIsApiGetDriverEfficiencyByVehiclesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a list of the organization\'s form templates. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Preview** under the category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Get a list of form templates.
* @param {PreviewAPIsApiGetFormTemplatesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
getFormTemplates(requestParameters?: PreviewAPIsApiGetFormTemplatesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Gets service tasks. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Gets service tasks.
* @param {PreviewAPIsApiGetServiceTasksRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
getServiceTasks(requestParameters?: PreviewAPIsApiGetServiceTasksRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Gets work orders. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Gets work orders.
* @param {PreviewAPIsApiGetWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
getWorkOrders(requestParameters?: PreviewAPIsApiGetWorkOrdersRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Updates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Updates a work order.
* @param {PreviewAPIsApiPatchWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
patchWorkOrders(requestParameters: PreviewAPIsApiPatchWorkOrdersRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Create a custom report run which then gets queued up to generate custom report data for the report run. Rate limit: 240 requests/day (learn more about rate limits here). To use this endpoint, select **Write Custom Reports** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Create a custom report run
* @param {PreviewAPIsApiPostCustomReportRunRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
postCustomReportRun(requestParameters: PreviewAPIsApiPostCustomReportRunRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Creates a work order. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Creates a work order.
* @param {PreviewAPIsApiPostWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
postWorkOrders(requestParameters: PreviewAPIsApiPostWorkOrdersRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Stream work orders. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. Learn More. Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications - Samsara may change the structure of a preview API\'s interface without versioning or any notice to API users. - When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog). **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary [preview] Stream work orders.
* @param {PreviewAPIsApiStreamWorkOrdersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PreviewAPIsApi
*/
streamWorkOrders(requestParameters: PreviewAPIsApiStreamWorkOrdersRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const StreamWorkOrdersWorkOrderStatusesEnum: {
readonly Assigned: "ASSIGNED";
readonly Cancelled: "CANCELLED";
readonly Closed: "CLOSED";
readonly Completed: "COMPLETED";
readonly InProgress: "IN_PROGRESS";
readonly OnHold: "ON_HOLD";
readonly Open: "OPEN";
readonly PendingApproval: "PENDING_APPROVAL";
readonly PendingParts: "PENDING_PARTS";
};
export type StreamWorkOrdersWorkOrderStatusesEnum = typeof StreamWorkOrdersWorkOrderStatusesEnum[keyof typeof StreamWorkOrdersWorkOrderStatusesEnum];