/**
* 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 { SafetySettingsGetSafetySettingsResponseBody } from '../samsara-models';
import { SettingsGetComplianceSettingsResponseBody } from '../samsara-models';
import { SettingsGetDriverAppSettingsResponseBody } from '../samsara-models';
import { SettingsPatchComplianceSettingsRequestBody } from '../samsara-models';
import { SettingsPatchComplianceSettingsResponseBody } from '../samsara-models';
import { SettingsPatchDriverAppSettingsRequestBody } from '../samsara-models';
import { SettingsPatchDriverAppSettingsResponseBody } from '../samsara-models';
/**
* SettingsApi - axios parameter creator
* @export
*/
export declare const SettingsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Get organization\'s compliance settings, including carrier name, office address, and DOT number Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get compliance settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComplianceSettings: (options?: RawAxiosRequestConfig) => Promise;
/**
* Get driver app settings. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver App Settings** under the Drivers 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 driver app settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverAppSettings: (options?: RawAxiosRequestConfig) => Promise;
/**
* Get safety settings Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get safety settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSafetySettings: (options?: RawAxiosRequestConfig) => Promise;
/**
* Update organization\'s compliance settings, including carrier name, office address, and DOT number Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update compliance settings
* @param {SettingsPatchComplianceSettingsRequestBody} patchComplianceSettingsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchComplianceSettings: (patchComplianceSettingsRequestBody: SettingsPatchComplianceSettingsRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Update driver app settings. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Driver App Settings** under the Drivers 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 driver app settings
* @param {SettingsPatchDriverAppSettingsRequestBody} patchDriverAppSettingsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchDriverAppSettings: (patchDriverAppSettingsRequestBody: SettingsPatchDriverAppSettingsRequestBody, options?: RawAxiosRequestConfig) => Promise;
};
/**
* SettingsApi - functional programming interface
* @export
*/
export declare const SettingsApiFp: (configuration?: Configuration) => {
/**
* Get organization\'s compliance settings, including carrier name, office address, and DOT number Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get compliance settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComplianceSettings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get driver app settings. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver App Settings** under the Drivers 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 driver app settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverAppSettings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get safety settings Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get safety settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSafetySettings(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update organization\'s compliance settings, including carrier name, office address, and DOT number Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update compliance settings
* @param {SettingsPatchComplianceSettingsRequestBody} patchComplianceSettingsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchComplianceSettings(patchComplianceSettingsRequestBody: SettingsPatchComplianceSettingsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update driver app settings. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Driver App Settings** under the Drivers 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 driver app settings
* @param {SettingsPatchDriverAppSettingsRequestBody} patchDriverAppSettingsRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchDriverAppSettings(patchDriverAppSettingsRequestBody: SettingsPatchDriverAppSettingsRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* SettingsApi - factory interface
* @export
*/
export declare const SettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Get organization\'s compliance settings, including carrier name, office address, and DOT number Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get compliance settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getComplianceSettings(options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get driver app settings. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver App Settings** under the Drivers 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 driver app settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getDriverAppSettings(options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get safety settings Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get safety settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSafetySettings(options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update organization\'s compliance settings, including carrier name, office address, and DOT number Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update compliance settings
* @param {SettingsApiPatchComplianceSettingsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchComplianceSettings(requestParameters: SettingsApiPatchComplianceSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update driver app settings. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Driver App Settings** under the Drivers 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 driver app settings
* @param {SettingsApiPatchDriverAppSettingsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchDriverAppSettings(requestParameters: SettingsApiPatchDriverAppSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for patchComplianceSettings operation in SettingsApi.
* @export
* @interface SettingsApiPatchComplianceSettingsRequest
*/
export interface SettingsApiPatchComplianceSettingsRequest {
/**
*
* @type {SettingsPatchComplianceSettingsRequestBody}
* @memberof SettingsApiPatchComplianceSettings
*/
readonly patchComplianceSettingsRequestBody: SettingsPatchComplianceSettingsRequestBody;
}
/**
* Request parameters for patchDriverAppSettings operation in SettingsApi.
* @export
* @interface SettingsApiPatchDriverAppSettingsRequest
*/
export interface SettingsApiPatchDriverAppSettingsRequest {
/**
*
* @type {SettingsPatchDriverAppSettingsRequestBody}
* @memberof SettingsApiPatchDriverAppSettings
*/
readonly patchDriverAppSettingsRequestBody: SettingsPatchDriverAppSettingsRequestBody;
}
/**
* SettingsApi - object-oriented interface
* @export
* @class SettingsApi
* @extends {BaseAPI}
*/
export declare class SettingsApi extends BaseAPI {
/**
* Get organization\'s compliance settings, including carrier name, office address, and DOT number Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get compliance settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SettingsApi
*/
getComplianceSettings(options?: RawAxiosRequestConfig): Promise>;
/**
* Get driver app settings. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Driver App Settings** under the Drivers 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 driver app settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SettingsApi
*/
getDriverAppSettings(options?: RawAxiosRequestConfig): Promise>;
/**
* Get safety settings Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Get safety settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SettingsApi
*/
getSafetySettings(options?: RawAxiosRequestConfig): Promise>;
/**
* Update organization\'s compliance settings, including carrier name, office address, and DOT number Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. Learn More. **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.
* @summary Update compliance settings
* @param {SettingsApiPatchComplianceSettingsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SettingsApi
*/
patchComplianceSettings(requestParameters: SettingsApiPatchComplianceSettingsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Update driver app settings. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Driver App Settings** under the Drivers 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 driver app settings
* @param {SettingsApiPatchDriverAppSettingsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SettingsApi
*/
patchDriverAppSettings(requestParameters: SettingsApiPatchDriverAppSettingsRequest, options?: RawAxiosRequestConfig): Promise>;
}