/**
* 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 { DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody } from '../samsara-models';
import { DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentResponseBody } from '../samsara-models';
import { DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody } from '../samsara-models';
import { DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsResponseBody } from '../samsara-models';
import { DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody } from '../samsara-models';
import { DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentResponseBody } from '../samsara-models';
/**
* DriverVehicleAssignmentsApi - axios parameter creator
* @export
*/
export declare const DriverVehicleAssignmentsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Assign vehicle drive-time to a driver via API. For a step-by-step instruction on how to leverage this endpoint, see [this guide](https://developers.samsara.com/docs/creating-driver-vehicle-assignments) Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create a new driver-vehicle assignment
* @param {DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody} createDriverVehicleAssignmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDriverVehicleAssignment: (createDriverVehicleAssignmentRequestBody: DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Delete driver assignments that were created using the `POST fleet/driver-vehicle-assignments` endpoint for the requested vehicle in the requested time range. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete API generated driver-vehicle assignments
* @param {DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody} deleteDriverVehicleAssignmentsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDriverVehicleAssignments: (deleteDriverVehicleAssignmentsRequestBody: DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Get all driver-vehicle assignments for the requested drivers or vehicles in the requested time range. To fetch driver-vehicle assignments out of the vehicle trips\' time ranges, assignmentType needs to be specified. Note: this endpoint replaces past endpoints to fetch assignments by driver or by vehicle. Visit [this migration guide](https://developers.samsara.com/docs/migrating-from-driver-vehicle-assignment-or-vehicle-driver-assignment-endpoints) for more information. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get all driver-vehicle assignments
* @param {GetDriverVehicleAssignmentsFilterByEnum} filterBy Option to filter by drivers or vehicles. Valid values: `drivers`, `vehicles`
* @param {string} [startTime] A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [driverIds] A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @param {Array} [vehicleIds] ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: \"key:value\". For example, \"maintenanceId:250020\".
* @param {string} [driverTagIds] A filter on the data based on this comma-separated list of driver tag IDs. Example: `tagIds=1234,5678`
* @param {string} [vehicleTagIds] A filter on the data based on this comma-separated list of vehicle tag IDs. Example: `tagIds=1234,5678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {GetDriverVehicleAssignmentsAssignmentTypeEnum} [assignmentType] Specifies which assignment type to filter by. Valid values: `HOS`, `idCard`, `static`, `faceId`, `tachograph`, `safetyManual`, `RFID`, `trailer`, `external`, `qrCode`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverVehicleAssignments: (filterBy: GetDriverVehicleAssignmentsFilterByEnum, startTime?: string, endTime?: string, driverIds?: Array, vehicleIds?: Array, driverTagIds?: string, vehicleTagIds?: string, after?: string, assignmentType?: GetDriverVehicleAssignmentsAssignmentTypeEnum, options?: RawAxiosRequestConfig) => Promise;
/**
* Update driver assignments that were created using the `POST fleet/driver-vehicle-assignments`. Vehicle Id, Driver Id, and Start Time must match an existing assignment. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update API generated driver-vehicle assignments
* @param {DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody} updateDriverVehicleAssignmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDriverVehicleAssignment: (updateDriverVehicleAssignmentRequestBody: DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise;
};
/**
* DriverVehicleAssignmentsApi - functional programming interface
* @export
*/
export declare const DriverVehicleAssignmentsApiFp: (configuration?: Configuration) => {
/**
* Assign vehicle drive-time to a driver via API. For a step-by-step instruction on how to leverage this endpoint, see [this guide](https://developers.samsara.com/docs/creating-driver-vehicle-assignments) Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create a new driver-vehicle assignment
* @param {DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody} createDriverVehicleAssignmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDriverVehicleAssignment(createDriverVehicleAssignmentRequestBody: DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Delete driver assignments that were created using the `POST fleet/driver-vehicle-assignments` endpoint for the requested vehicle in the requested time range. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete API generated driver-vehicle assignments
* @param {DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody} deleteDriverVehicleAssignmentsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDriverVehicleAssignments(deleteDriverVehicleAssignmentsRequestBody: DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get all driver-vehicle assignments for the requested drivers or vehicles in the requested time range. To fetch driver-vehicle assignments out of the vehicle trips\' time ranges, assignmentType needs to be specified. Note: this endpoint replaces past endpoints to fetch assignments by driver or by vehicle. Visit [this migration guide](https://developers.samsara.com/docs/migrating-from-driver-vehicle-assignment-or-vehicle-driver-assignment-endpoints) for more information. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get all driver-vehicle assignments
* @param {GetDriverVehicleAssignmentsFilterByEnum} filterBy Option to filter by drivers or vehicles. Valid values: `drivers`, `vehicles`
* @param {string} [startTime] A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {string} [endTime] An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).
* @param {Array} [driverIds] A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`
* @param {Array} [vehicleIds] ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: \"key:value\". For example, \"maintenanceId:250020\".
* @param {string} [driverTagIds] A filter on the data based on this comma-separated list of driver tag IDs. Example: `tagIds=1234,5678`
* @param {string} [vehicleTagIds] A filter on the data based on this comma-separated list of vehicle tag IDs. Example: `tagIds=1234,5678`
* @param {string} [after] If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.
* @param {GetDriverVehicleAssignmentsAssignmentTypeEnum} [assignmentType] Specifies which assignment type to filter by. Valid values: `HOS`, `idCard`, `static`, `faceId`, `tachograph`, `safetyManual`, `RFID`, `trailer`, `external`, `qrCode`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverVehicleAssignments(filterBy: GetDriverVehicleAssignmentsFilterByEnum, startTime?: string, endTime?: string, driverIds?: Array, vehicleIds?: Array, driverTagIds?: string, vehicleTagIds?: string, after?: string, assignmentType?: GetDriverVehicleAssignmentsAssignmentTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update driver assignments that were created using the `POST fleet/driver-vehicle-assignments`. Vehicle Id, Driver Id, and Start Time must match an existing assignment. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update API generated driver-vehicle assignments
* @param {DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody} updateDriverVehicleAssignmentRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDriverVehicleAssignment(updateDriverVehicleAssignmentRequestBody: DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* DriverVehicleAssignmentsApi - factory interface
* @export
*/
export declare const DriverVehicleAssignmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Assign vehicle drive-time to a driver via API. For a step-by-step instruction on how to leverage this endpoint, see [this guide](https://developers.samsara.com/docs/creating-driver-vehicle-assignments) Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create a new driver-vehicle assignment
* @param {DriverVehicleAssignmentsApiCreateDriverVehicleAssignmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createDriverVehicleAssignment(requestParameters: DriverVehicleAssignmentsApiCreateDriverVehicleAssignmentRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Delete driver assignments that were created using the `POST fleet/driver-vehicle-assignments` endpoint for the requested vehicle in the requested time range. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete API generated driver-vehicle assignments
* @param {DriverVehicleAssignmentsApiDeleteDriverVehicleAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteDriverVehicleAssignments(requestParameters: DriverVehicleAssignmentsApiDeleteDriverVehicleAssignmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get all driver-vehicle assignments for the requested drivers or vehicles in the requested time range. To fetch driver-vehicle assignments out of the vehicle trips\' time ranges, assignmentType needs to be specified. Note: this endpoint replaces past endpoints to fetch assignments by driver or by vehicle. Visit [this migration guide](https://developers.samsara.com/docs/migrating-from-driver-vehicle-assignment-or-vehicle-driver-assignment-endpoints) for more information. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get all driver-vehicle assignments
* @param {DriverVehicleAssignmentsApiGetDriverVehicleAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverVehicleAssignments(requestParameters: DriverVehicleAssignmentsApiGetDriverVehicleAssignmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update driver assignments that were created using the `POST fleet/driver-vehicle-assignments`. Vehicle Id, Driver Id, and Start Time must match an existing assignment. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update API generated driver-vehicle assignments
* @param {DriverVehicleAssignmentsApiUpdateDriverVehicleAssignmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateDriverVehicleAssignment(requestParameters: DriverVehicleAssignmentsApiUpdateDriverVehicleAssignmentRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for createDriverVehicleAssignment operation in DriverVehicleAssignmentsApi.
* @export
* @interface DriverVehicleAssignmentsApiCreateDriverVehicleAssignmentRequest
*/
export interface DriverVehicleAssignmentsApiCreateDriverVehicleAssignmentRequest {
/**
*
* @type {DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody}
* @memberof DriverVehicleAssignmentsApiCreateDriverVehicleAssignment
*/
readonly createDriverVehicleAssignmentRequestBody: DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody;
}
/**
* Request parameters for deleteDriverVehicleAssignments operation in DriverVehicleAssignmentsApi.
* @export
* @interface DriverVehicleAssignmentsApiDeleteDriverVehicleAssignmentsRequest
*/
export interface DriverVehicleAssignmentsApiDeleteDriverVehicleAssignmentsRequest {
/**
*
* @type {DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody}
* @memberof DriverVehicleAssignmentsApiDeleteDriverVehicleAssignments
*/
readonly deleteDriverVehicleAssignmentsRequestBody: DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody;
}
/**
* Request parameters for getDriverVehicleAssignments operation in DriverVehicleAssignmentsApi.
* @export
* @interface DriverVehicleAssignmentsApiGetDriverVehicleAssignmentsRequest
*/
export interface DriverVehicleAssignmentsApiGetDriverVehicleAssignmentsRequest {
/**
* Option to filter by drivers or vehicles. Valid values: `drivers`, `vehicles`
* @type {'drivers' | 'vehicles'}
* @memberof DriverVehicleAssignmentsApiGetDriverVehicleAssignments
*/
readonly filterBy: GetDriverVehicleAssignmentsFilterByEnum;
/**
* 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 DriverVehicleAssignmentsApiGetDriverVehicleAssignments
*/
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 DriverVehicleAssignmentsApiGetDriverVehicleAssignments
*/
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 DriverVehicleAssignmentsApiGetDriverVehicleAssignments
*/
readonly driverIds?: Array;
/**
* ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: \"key:value\". For example, \"maintenanceId:250020\".
* @type {Array}
* @memberof DriverVehicleAssignmentsApiGetDriverVehicleAssignments
*/
readonly vehicleIds?: Array;
/**
* A filter on the data based on this comma-separated list of driver tag IDs. Example: `tagIds=1234,5678`
* @type {string}
* @memberof DriverVehicleAssignmentsApiGetDriverVehicleAssignments
*/
readonly driverTagIds?: string;
/**
* A filter on the data based on this comma-separated list of vehicle tag IDs. Example: `tagIds=1234,5678`
* @type {string}
* @memberof DriverVehicleAssignmentsApiGetDriverVehicleAssignments
*/
readonly vehicleTagIds?: 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 DriverVehicleAssignmentsApiGetDriverVehicleAssignments
*/
readonly after?: string;
/**
* Specifies which assignment type to filter by. Valid values: `HOS`, `idCard`, `static`, `faceId`, `tachograph`, `safetyManual`, `RFID`, `trailer`, `external`, `qrCode`
* @type {'HOS' | 'idCard' | 'static' | 'faceId' | 'tachograph' | 'safetyManual' | 'RFID' | 'trailer' | 'external' | 'qrCode'}
* @memberof DriverVehicleAssignmentsApiGetDriverVehicleAssignments
*/
readonly assignmentType?: GetDriverVehicleAssignmentsAssignmentTypeEnum;
}
/**
* Request parameters for updateDriverVehicleAssignment operation in DriverVehicleAssignmentsApi.
* @export
* @interface DriverVehicleAssignmentsApiUpdateDriverVehicleAssignmentRequest
*/
export interface DriverVehicleAssignmentsApiUpdateDriverVehicleAssignmentRequest {
/**
*
* @type {DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody}
* @memberof DriverVehicleAssignmentsApiUpdateDriverVehicleAssignment
*/
readonly updateDriverVehicleAssignmentRequestBody: DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody;
}
/**
* DriverVehicleAssignmentsApi - object-oriented interface
* @export
* @class DriverVehicleAssignmentsApi
* @extends {BaseAPI}
*/
export declare class DriverVehicleAssignmentsApi extends BaseAPI {
/**
* Assign vehicle drive-time to a driver via API. For a step-by-step instruction on how to leverage this endpoint, see [this guide](https://developers.samsara.com/docs/creating-driver-vehicle-assignments) Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Create a new driver-vehicle assignment
* @param {DriverVehicleAssignmentsApiCreateDriverVehicleAssignmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DriverVehicleAssignmentsApi
*/
createDriverVehicleAssignment(requestParameters: DriverVehicleAssignmentsApiCreateDriverVehicleAssignmentRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Delete driver assignments that were created using the `POST fleet/driver-vehicle-assignments` endpoint for the requested vehicle in the requested time range. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Delete API generated driver-vehicle assignments
* @param {DriverVehicleAssignmentsApiDeleteDriverVehicleAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DriverVehicleAssignmentsApi
*/
deleteDriverVehicleAssignments(requestParameters: DriverVehicleAssignmentsApiDeleteDriverVehicleAssignmentsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get all driver-vehicle assignments for the requested drivers or vehicles in the requested time range. To fetch driver-vehicle assignments out of the vehicle trips\' time ranges, assignmentType needs to be specified. Note: this endpoint replaces past endpoints to fetch assignments by driver or by vehicle. Visit [this migration guide](https://developers.samsara.com/docs/migrating-from-driver-vehicle-assignment-or-vehicle-driver-assignment-endpoints) for more information. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get all driver-vehicle assignments
* @param {DriverVehicleAssignmentsApiGetDriverVehicleAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DriverVehicleAssignmentsApi
*/
getDriverVehicleAssignments(requestParameters: DriverVehicleAssignmentsApiGetDriverVehicleAssignmentsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Update driver assignments that were created using the `POST fleet/driver-vehicle-assignments`. Vehicle Id, Driver Id, and Start Time must match an existing assignment. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update API generated driver-vehicle assignments
* @param {DriverVehicleAssignmentsApiUpdateDriverVehicleAssignmentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DriverVehicleAssignmentsApi
*/
updateDriverVehicleAssignment(requestParameters: DriverVehicleAssignmentsApiUpdateDriverVehicleAssignmentRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const GetDriverVehicleAssignmentsFilterByEnum: {
readonly Drivers: "drivers";
readonly Vehicles: "vehicles";
};
export type GetDriverVehicleAssignmentsFilterByEnum = typeof GetDriverVehicleAssignmentsFilterByEnum[keyof typeof GetDriverVehicleAssignmentsFilterByEnum];
/**
* @export
*/
export declare const GetDriverVehicleAssignmentsAssignmentTypeEnum: {
readonly Hos: "HOS";
readonly IdCard: "idCard";
readonly Static: "static";
readonly FaceId: "faceId";
readonly Tachograph: "tachograph";
readonly SafetyManual: "safetyManual";
readonly Rfid: "RFID";
readonly Trailer: "trailer";
readonly External: "external";
readonly QrCode: "qrCode";
};
export type GetDriverVehicleAssignmentsAssignmentTypeEnum = typeof GetDriverVehicleAssignmentsAssignmentTypeEnum[keyof typeof GetDriverVehicleAssignmentsAssignmentTypeEnum];