/**
* 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 { DocumentPdfGenerationRequest } from '../samsara-models';
import { DocumentPdfGenerationResponse } from '../samsara-models';
import { DocumentPdfQueryResponse } from '../samsara-models';
import { DocumentTypesGetDocumentTypesResponseBody } from '../samsara-models';
import { DocumentsGetDocumentResponseBody } from '../samsara-models';
import { DocumentsGetDocumentsResponseBody } from '../samsara-models';
import { DocumentsPostDocumentRequestBody } from '../samsara-models';
import { DocumentsPostDocumentResponseBody } from '../samsara-models';
/**
* DocumentsApi - axios parameter creator
* @export
*/
export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Deletes a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/deleteDriverDocumentByIdAndDriverId). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete document
* @param {string} id ID of the document to delete
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDocument: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Request creation of a document PDF. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More.
* @summary Create a document PDF
* @param {DocumentPdfGenerationRequest} [document] Specifies the document for which to generate a PDF.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
generateDocumentPdf: (document?: DocumentPdfGenerationRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentByIdAndDriverId). Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch document
* @param {string} id ID of the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocument: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns generation job status and download URL for a PDF. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More.
* @summary Query a document PDF
* @param {string} id ID of the pdf.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocumentPdf: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a list of the organization document types. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentTypesByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch document types
* @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}
*/
getDocumentTypes: (after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get all documents for the given time range. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentsByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch all documents
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [documentTypeId] ID of the document template type.
* @param {string} [queryBy] Query by document creation time (`created`) or updated time (`updated`). Defaults to `created`.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocuments: (startTime: string, endTime: string, after?: string, documentTypeId?: string, queryBy?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Creates a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/createDriverDocument). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create document
* @param {DocumentsPostDocumentRequestBody} postDocumentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postDocument: (postDocumentRequestBody: DocumentsPostDocumentRequestBody, options?: RawAxiosRequestConfig) => Promise;
};
/**
* DocumentsApi - functional programming interface
* @export
*/
export declare const DocumentsApiFp: (configuration?: Configuration) => {
/**
* Deletes a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/deleteDriverDocumentByIdAndDriverId). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete document
* @param {string} id ID of the document to delete
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDocument(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Request creation of a document PDF. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More.
* @summary Create a document PDF
* @param {DocumentPdfGenerationRequest} [document] Specifies the document for which to generate a PDF.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
generateDocumentPdf(document?: DocumentPdfGenerationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentByIdAndDriverId). Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch document
* @param {string} id ID of the document
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocument(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns generation job status and download URL for a PDF. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More.
* @summary Query a document PDF
* @param {string} id ID of the pdf.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocumentPdf(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a list of the organization document types. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentTypesByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch document types
* @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}
*/
getDocumentTypes(after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get all documents for the given time range. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentsByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch all documents
* @param {string} startTime A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} endTime An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {string} [documentTypeId] ID of the document template type.
* @param {string} [queryBy] Query by document creation time (`created`) or updated time (`updated`). Defaults to `created`.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocuments(startTime: string, endTime: string, after?: string, documentTypeId?: string, queryBy?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Creates a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/createDriverDocument). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create document
* @param {DocumentsPostDocumentRequestBody} postDocumentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postDocument(postDocumentRequestBody: DocumentsPostDocumentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* DocumentsApi - factory interface
* @export
*/
export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Deletes a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/deleteDriverDocumentByIdAndDriverId). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete document
* @param {DocumentsApiDeleteDocumentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDocument(requestParameters: DocumentsApiDeleteDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Request creation of a document PDF. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More.
* @summary Create a document PDF
* @param {DocumentsApiGenerateDocumentPdfRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
generateDocumentPdf(requestParameters?: DocumentsApiGenerateDocumentPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentByIdAndDriverId). Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch document
* @param {DocumentsApiGetDocumentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocument(requestParameters: DocumentsApiGetDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns generation job status and download URL for a PDF. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More.
* @summary Query a document PDF
* @param {DocumentsApiGetDocumentPdfRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocumentPdf(requestParameters: DocumentsApiGetDocumentPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of the organization document types. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentTypesByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch document types
* @param {DocumentsApiGetDocumentTypesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocumentTypes(requestParameters?: DocumentsApiGetDocumentTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get all documents for the given time range. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentsByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch all documents
* @param {DocumentsApiGetDocumentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDocuments(requestParameters: DocumentsApiGetDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Creates a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/createDriverDocument). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create document
* @param {DocumentsApiPostDocumentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postDocument(requestParameters: DocumentsApiPostDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteDocument operation in DocumentsApi.
* @export
* @interface DocumentsApiDeleteDocumentRequest
*/
export interface DocumentsApiDeleteDocumentRequest {
/**
* ID of the document to delete
* @type {string}
* @memberof DocumentsApiDeleteDocument
*/
readonly id: string;
}
/**
* Request parameters for generateDocumentPdf operation in DocumentsApi.
* @export
* @interface DocumentsApiGenerateDocumentPdfRequest
*/
export interface DocumentsApiGenerateDocumentPdfRequest {
/**
* Specifies the document for which to generate a PDF.
* @type {DocumentPdfGenerationRequest}
* @memberof DocumentsApiGenerateDocumentPdf
*/
readonly document?: DocumentPdfGenerationRequest;
}
/**
* Request parameters for getDocument operation in DocumentsApi.
* @export
* @interface DocumentsApiGetDocumentRequest
*/
export interface DocumentsApiGetDocumentRequest {
/**
* ID of the document
* @type {string}
* @memberof DocumentsApiGetDocument
*/
readonly id: string;
}
/**
* Request parameters for getDocumentPdf operation in DocumentsApi.
* @export
* @interface DocumentsApiGetDocumentPdfRequest
*/
export interface DocumentsApiGetDocumentPdfRequest {
/**
* ID of the pdf.
* @type {string}
* @memberof DocumentsApiGetDocumentPdf
*/
readonly id: string;
}
/**
* Request parameters for getDocumentTypes operation in DocumentsApi.
* @export
* @interface DocumentsApiGetDocumentTypesRequest
*/
export interface DocumentsApiGetDocumentTypesRequest {
/**
* 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 DocumentsApiGetDocumentTypes
*/
readonly after?: string;
}
/**
* Request parameters for getDocuments operation in DocumentsApi.
* @export
* @interface DocumentsApiGetDocumentsRequest
*/
export interface DocumentsApiGetDocumentsRequest {
/**
* A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @type {string}
* @memberof DocumentsApiGetDocuments
*/
readonly startTime: 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 DocumentsApiGetDocuments
*/
readonly endTime: 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 DocumentsApiGetDocuments
*/
readonly after?: string;
/**
* ID of the document template type.
* @type {string}
* @memberof DocumentsApiGetDocuments
*/
readonly documentTypeId?: string;
/**
* Query by document creation time (`created`) or updated time (`updated`). Defaults to `created`.
* @type {string}
* @memberof DocumentsApiGetDocuments
*/
readonly queryBy?: string;
}
/**
* Request parameters for postDocument operation in DocumentsApi.
* @export
* @interface DocumentsApiPostDocumentRequest
*/
export interface DocumentsApiPostDocumentRequest {
/**
*
* @type {DocumentsPostDocumentRequestBody}
* @memberof DocumentsApiPostDocument
*/
readonly postDocumentRequestBody: DocumentsPostDocumentRequestBody;
}
/**
* DocumentsApi - object-oriented interface
* @export
* @class DocumentsApi
* @extends {BaseAPI}
*/
export declare class DocumentsApi extends BaseAPI {
/**
* Deletes a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/deleteDriverDocumentByIdAndDriverId). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete document
* @param {DocumentsApiDeleteDocumentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
deleteDocument(requestParameters: DocumentsApiDeleteDocumentRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Request creation of a document PDF. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More.
* @summary Create a document PDF
* @param {DocumentsApiGenerateDocumentPdfRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
generateDocumentPdf(requestParameters?: DocumentsApiGenerateDocumentPdfRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentByIdAndDriverId). Rate limit: 25 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch document
* @param {DocumentsApiGetDocumentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
getDocument(requestParameters: DocumentsApiGetDocumentRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns generation job status and download URL for a PDF. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team. To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More.
* @summary Query a document PDF
* @param {DocumentsApiGetDocumentPdfRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
getDocumentPdf(requestParameters: DocumentsApiGetDocumentPdfRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a list of the organization document types. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentTypesByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch document types
* @param {DocumentsApiGetDocumentTypesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
getDocumentTypes(requestParameters?: DocumentsApiGetDocumentTypesRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get all documents for the given time range. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentsByOrgId). Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Fetch all documents
* @param {DocumentsApiGetDocumentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
getDocuments(requestParameters: DocumentsApiGetDocumentsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Creates a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/createDriverDocument). Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create document
* @param {DocumentsApiPostDocumentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DocumentsApi
*/
postDocument(requestParameters: DocumentsApiPostDocumentRequest, options?: RawAxiosRequestConfig): Promise>;
}