/**
* 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 { FieldObjectPostRequestBody } from './field-object-post-request-body';
/**
*
* @export
* @interface DocumentsPostDocumentRequestBody
*/
export interface DocumentsPostDocumentRequestBody {
/**
* ID for the document type.
* @type {string}
* @memberof DocumentsPostDocumentRequestBody
*/
'documentTypeId': string;
/**
* ID of the driver. Can be either unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the driver.
* @type {string}
* @memberof DocumentsPostDocumentRequestBody
*/
'driverId': string;
/**
* The fields associated with this document.
* @type {Array}
* @memberof DocumentsPostDocumentRequestBody
*/
'fields'?: Array;
/**
* Name of the document.
* @type {string}
* @memberof DocumentsPostDocumentRequestBody
*/
'name'?: string;
/**
* Notes on the document.
* @type {string}
* @memberof DocumentsPostDocumentRequestBody
*/
'notes'?: string;
/**
* ID of the route stop. Can be either unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the route stop.
* @type {string}
* @memberof DocumentsPostDocumentRequestBody
*/
'routeStopId'?: string;
/**
* The condition of the document created for the driver. Can be either `required` or `submitted`, if no value is specified, `state` defaults to `required`. `required` documents are pre-populated documents for the Driver to fill out in the Driver App. Valid values: `submitted`, `required`
* @type {string}
* @memberof DocumentsPostDocumentRequestBody
*/
'state'?: DocumentsPostDocumentRequestBodyStateEnum;
/**
* ID of the vehicle. Can be either unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the vehicle.
* @type {string}
* @memberof DocumentsPostDocumentRequestBody
*/
'vehicleId'?: string;
}
export declare const DocumentsPostDocumentRequestBodyStateEnum: {
readonly Submitted: "submitted";
readonly Required: "required";
};
export type DocumentsPostDocumentRequestBodyStateEnum = typeof DocumentsPostDocumentRequestBodyStateEnum[keyof typeof DocumentsPostDocumentRequestBodyStateEnum];