/**
* 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 { LiveSharingLinksCreateLiveSharingLinkRequestBody } from '../samsara-models';
import { LiveSharingLinksCreateLiveSharingLinkResponseBody } from '../samsara-models';
import { LiveSharingLinksGetLiveSharingLinksResponseBody } from '../samsara-models';
import { LiveSharingLinksUpdateLiveSharingLinkRequestBody } from '../samsara-models';
import { LiveSharingLinksUpdateLiveSharingLinkResponseBody } from '../samsara-models';
/**
* LiveSharingLinksApi - axios parameter creator
* @export
*/
export declare const LiveSharingLinksApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Create Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 Live Sharing Link
* @param {LiveSharingLinksCreateLiveSharingLinkRequestBody} createLiveSharingLinkRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createLiveSharingLink: (createLiveSharingLinkRequestBody: LiveSharingLinksCreateLiveSharingLinkRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Delete Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 non-expired Live Sharing Link
* @param {string} id Unique identifier for the Live Sharing Link.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteLiveSharingLink: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns all non-expired Live Sharing Links. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Live Sharing Links** 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 Get Live Sharing Links
* @param {Array} [ids] A filter on the data based on this comma-separated list of Live Share Link IDs
* @param {GetLiveSharingLinksTypeEnum} [type] A filter on the data based on the Live Sharing Link type. Valid values: `all`, `assetsLocation`, `assetsNearLocation`, `assetsOnRoute`
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 100 objects.
* @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}
*/
getLiveSharingLinks: (ids?: Array, type?: GetLiveSharingLinksTypeEnum, limit?: number, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Update Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 Update non-expired Live Sharing Link
* @param {string} id Unique identifier for the Live Sharing Link.
* @param {LiveSharingLinksUpdateLiveSharingLinkRequestBody} updateLiveSharingLinkRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateLiveSharingLink: (id: string, updateLiveSharingLinkRequestBody: LiveSharingLinksUpdateLiveSharingLinkRequestBody, options?: RawAxiosRequestConfig) => Promise;
};
/**
* LiveSharingLinksApi - functional programming interface
* @export
*/
export declare const LiveSharingLinksApiFp: (configuration?: Configuration) => {
/**
* Create Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 Live Sharing Link
* @param {LiveSharingLinksCreateLiveSharingLinkRequestBody} createLiveSharingLinkRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createLiveSharingLink(createLiveSharingLinkRequestBody: LiveSharingLinksCreateLiveSharingLinkRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Delete Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 non-expired Live Sharing Link
* @param {string} id Unique identifier for the Live Sharing Link.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteLiveSharingLink(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns all non-expired Live Sharing Links. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Live Sharing Links** 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 Get Live Sharing Links
* @param {Array} [ids] A filter on the data based on this comma-separated list of Live Share Link IDs
* @param {GetLiveSharingLinksTypeEnum} [type] A filter on the data based on the Live Sharing Link type. Valid values: `all`, `assetsLocation`, `assetsNearLocation`, `assetsOnRoute`
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 100 objects.
* @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}
*/
getLiveSharingLinks(ids?: Array, type?: GetLiveSharingLinksTypeEnum, limit?: number, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 Update non-expired Live Sharing Link
* @param {string} id Unique identifier for the Live Sharing Link.
* @param {LiveSharingLinksUpdateLiveSharingLinkRequestBody} updateLiveSharingLinkRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateLiveSharingLink(id: string, updateLiveSharingLinkRequestBody: LiveSharingLinksUpdateLiveSharingLinkRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* LiveSharingLinksApi - factory interface
* @export
*/
export declare const LiveSharingLinksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Create Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 Live Sharing Link
* @param {LiveSharingLinksApiCreateLiveSharingLinkRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createLiveSharingLink(requestParameters: LiveSharingLinksApiCreateLiveSharingLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Delete Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 non-expired Live Sharing Link
* @param {LiveSharingLinksApiDeleteLiveSharingLinkRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteLiveSharingLink(requestParameters: LiveSharingLinksApiDeleteLiveSharingLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns all non-expired Live Sharing Links. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Live Sharing Links** 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 Get Live Sharing Links
* @param {LiveSharingLinksApiGetLiveSharingLinksRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getLiveSharingLinks(requestParameters?: LiveSharingLinksApiGetLiveSharingLinksRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 Update non-expired Live Sharing Link
* @param {LiveSharingLinksApiUpdateLiveSharingLinkRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateLiveSharingLink(requestParameters: LiveSharingLinksApiUpdateLiveSharingLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for createLiveSharingLink operation in LiveSharingLinksApi.
* @export
* @interface LiveSharingLinksApiCreateLiveSharingLinkRequest
*/
export interface LiveSharingLinksApiCreateLiveSharingLinkRequest {
/**
*
* @type {LiveSharingLinksCreateLiveSharingLinkRequestBody}
* @memberof LiveSharingLinksApiCreateLiveSharingLink
*/
readonly createLiveSharingLinkRequestBody: LiveSharingLinksCreateLiveSharingLinkRequestBody;
}
/**
* Request parameters for deleteLiveSharingLink operation in LiveSharingLinksApi.
* @export
* @interface LiveSharingLinksApiDeleteLiveSharingLinkRequest
*/
export interface LiveSharingLinksApiDeleteLiveSharingLinkRequest {
/**
* Unique identifier for the Live Sharing Link.
* @type {string}
* @memberof LiveSharingLinksApiDeleteLiveSharingLink
*/
readonly id: string;
}
/**
* Request parameters for getLiveSharingLinks operation in LiveSharingLinksApi.
* @export
* @interface LiveSharingLinksApiGetLiveSharingLinksRequest
*/
export interface LiveSharingLinksApiGetLiveSharingLinksRequest {
/**
* A filter on the data based on this comma-separated list of Live Share Link IDs
* @type {Array}
* @memberof LiveSharingLinksApiGetLiveSharingLinks
*/
readonly ids?: Array;
/**
* A filter on the data based on the Live Sharing Link type. Valid values: `all`, `assetsLocation`, `assetsNearLocation`, `assetsOnRoute`
* @type {'all' | 'assetsLocation' | 'assetsNearLocation' | 'assetsOnRoute'}
* @memberof LiveSharingLinksApiGetLiveSharingLinks
*/
readonly type?: GetLiveSharingLinksTypeEnum;
/**
* The limit for how many objects will be in the response. Default and max for this value is 100 objects.
* @type {number}
* @memberof LiveSharingLinksApiGetLiveSharingLinks
*/
readonly limit?: number;
/**
* 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 LiveSharingLinksApiGetLiveSharingLinks
*/
readonly after?: string;
}
/**
* Request parameters for updateLiveSharingLink operation in LiveSharingLinksApi.
* @export
* @interface LiveSharingLinksApiUpdateLiveSharingLinkRequest
*/
export interface LiveSharingLinksApiUpdateLiveSharingLinkRequest {
/**
* Unique identifier for the Live Sharing Link.
* @type {string}
* @memberof LiveSharingLinksApiUpdateLiveSharingLink
*/
readonly id: string;
/**
*
* @type {LiveSharingLinksUpdateLiveSharingLinkRequestBody}
* @memberof LiveSharingLinksApiUpdateLiveSharingLink
*/
readonly updateLiveSharingLinkRequestBody: LiveSharingLinksUpdateLiveSharingLinkRequestBody;
}
/**
* LiveSharingLinksApi - object-oriented interface
* @export
* @class LiveSharingLinksApi
* @extends {BaseAPI}
*/
export declare class LiveSharingLinksApi extends BaseAPI {
/**
* Create Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 Live Sharing Link
* @param {LiveSharingLinksApiCreateLiveSharingLinkRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LiveSharingLinksApi
*/
createLiveSharingLink(requestParameters: LiveSharingLinksApiCreateLiveSharingLinkRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Delete Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 non-expired Live Sharing Link
* @param {LiveSharingLinksApiDeleteLiveSharingLinkRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LiveSharingLinksApi
*/
deleteLiveSharingLink(requestParameters: LiveSharingLinksApiDeleteLiveSharingLinkRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns all non-expired Live Sharing Links. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Live Sharing Links** 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 Get Live Sharing Links
* @param {LiveSharingLinksApiGetLiveSharingLinksRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LiveSharingLinksApi
*/
getLiveSharingLinks(requestParameters?: LiveSharingLinksApiGetLiveSharingLinksRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Update Live Sharing Link. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Live Sharing Links** 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 Update non-expired Live Sharing Link
* @param {LiveSharingLinksApiUpdateLiveSharingLinkRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LiveSharingLinksApi
*/
updateLiveSharingLink(requestParameters: LiveSharingLinksApiUpdateLiveSharingLinkRequest, options?: RawAxiosRequestConfig): Promise>;
}
/**
* @export
*/
export declare const GetLiveSharingLinksTypeEnum: {
readonly All: "all";
readonly AssetsLocation: "assetsLocation";
readonly AssetsNearLocation: "assetsNearLocation";
readonly AssetsOnRoute: "assetsOnRoute";
};
export type GetLiveSharingLinksTypeEnum = typeof GetLiveSharingLinksTypeEnum[keyof typeof GetLiveSharingLinksTypeEnum];