/**
* 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 { WebhooksGetWebhookResponseBody } from '../samsara-models';
import { WebhooksListWebhooksResponseBody } from '../samsara-models';
import { WebhooksPatchWebhookRequestBody } from '../samsara-models';
import { WebhooksPatchWebhookResponseBody } from '../samsara-models';
import { WebhooksPostWebhooksRequestBody } from '../samsara-models';
import { WebhooksPostWebhooksResponseBody } from '../samsara-models';
/**
* WebhooksApi - axios parameter creator
* @export
*/
export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Delete a webhook with the given ID. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 a webhook with the given ID
* @param {string} id Unique identifier for the webhook to delete.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWebhook: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Retrieve a webhook with given ID. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** under the Setup & Administration 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 Retrieve a webhook with given ID
* @param {string} id ID of the webhook. This is the Samsara-specified ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWebhook: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* List all webhooks belonging to a specific org. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** under the Setup & Administration 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 List all webhooks belonging to a specific org.
* @param {string} [ids] A filter on the data based on this comma-separated list of webhook IDs. Example: `ids=49412323223,49412329928`
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 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}
*/
listWebhooks: (ids?: string, limit?: number, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Update a specific webhook\'s information. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard. This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource. For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 a specific webhook\'s information.
* @param {string} id Unique identifier for the webhook to update.
* @param {WebhooksPatchWebhookRequestBody} patchWebhookRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchWebhook: (id: string, patchWebhookRequestBody: WebhooksPatchWebhookRequestBody, options?: RawAxiosRequestConfig) => Promise;
/**
* Create a webhook Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 webhook
* @param {WebhooksPostWebhooksRequestBody} postWebhooksRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postWebhooks: (postWebhooksRequestBody: WebhooksPostWebhooksRequestBody, options?: RawAxiosRequestConfig) => Promise;
};
/**
* WebhooksApi - functional programming interface
* @export
*/
export declare const WebhooksApiFp: (configuration?: Configuration) => {
/**
* Delete a webhook with the given ID. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 a webhook with the given ID
* @param {string} id Unique identifier for the webhook to delete.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Retrieve a webhook with given ID. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** under the Setup & Administration 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 Retrieve a webhook with given ID
* @param {string} id ID of the webhook. This is the Samsara-specified ID.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWebhook(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* List all webhooks belonging to a specific org. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** under the Setup & Administration 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 List all webhooks belonging to a specific org.
* @param {string} [ids] A filter on the data based on this comma-separated list of webhook IDs. Example: `ids=49412323223,49412329928`
* @param {number} [limit] The limit for how many objects will be in the response. Default and max for this value is 512 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}
*/
listWebhooks(ids?: string, limit?: number, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update a specific webhook\'s information. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard. This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource. For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 a specific webhook\'s information.
* @param {string} id Unique identifier for the webhook to update.
* @param {WebhooksPatchWebhookRequestBody} patchWebhookRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchWebhook(id: string, patchWebhookRequestBody: WebhooksPatchWebhookRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Create a webhook Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 webhook
* @param {WebhooksPostWebhooksRequestBody} postWebhooksRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postWebhooks(postWebhooksRequestBody: WebhooksPostWebhooksRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* WebhooksApi - factory interface
* @export
*/
export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Delete a webhook with the given ID. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 a webhook with the given ID
* @param {WebhooksApiDeleteWebhookRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteWebhook(requestParameters: WebhooksApiDeleteWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Retrieve a webhook with given ID. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** under the Setup & Administration 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 Retrieve a webhook with given ID
* @param {WebhooksApiGetWebhookRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getWebhook(requestParameters: WebhooksApiGetWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* List all webhooks belonging to a specific org. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** under the Setup & Administration 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 List all webhooks belonging to a specific org.
* @param {WebhooksApiListWebhooksRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listWebhooks(requestParameters?: WebhooksApiListWebhooksRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update a specific webhook\'s information. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard. This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource. For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 a specific webhook\'s information.
* @param {WebhooksApiPatchWebhookRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
patchWebhook(requestParameters: WebhooksApiPatchWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Create a webhook Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 webhook
* @param {WebhooksApiPostWebhooksRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postWebhooks(requestParameters: WebhooksApiPostWebhooksRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteWebhook operation in WebhooksApi.
* @export
* @interface WebhooksApiDeleteWebhookRequest
*/
export interface WebhooksApiDeleteWebhookRequest {
/**
* Unique identifier for the webhook to delete.
* @type {string}
* @memberof WebhooksApiDeleteWebhook
*/
readonly id: string;
}
/**
* Request parameters for getWebhook operation in WebhooksApi.
* @export
* @interface WebhooksApiGetWebhookRequest
*/
export interface WebhooksApiGetWebhookRequest {
/**
* ID of the webhook. This is the Samsara-specified ID.
* @type {string}
* @memberof WebhooksApiGetWebhook
*/
readonly id: string;
}
/**
* Request parameters for listWebhooks operation in WebhooksApi.
* @export
* @interface WebhooksApiListWebhooksRequest
*/
export interface WebhooksApiListWebhooksRequest {
/**
* A filter on the data based on this comma-separated list of webhook IDs. Example: `ids=49412323223,49412329928`
* @type {string}
* @memberof WebhooksApiListWebhooks
*/
readonly ids?: string;
/**
* The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @type {number}
* @memberof WebhooksApiListWebhooks
*/
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 WebhooksApiListWebhooks
*/
readonly after?: string;
}
/**
* Request parameters for patchWebhook operation in WebhooksApi.
* @export
* @interface WebhooksApiPatchWebhookRequest
*/
export interface WebhooksApiPatchWebhookRequest {
/**
* Unique identifier for the webhook to update.
* @type {string}
* @memberof WebhooksApiPatchWebhook
*/
readonly id: string;
/**
*
* @type {WebhooksPatchWebhookRequestBody}
* @memberof WebhooksApiPatchWebhook
*/
readonly patchWebhookRequestBody: WebhooksPatchWebhookRequestBody;
}
/**
* Request parameters for postWebhooks operation in WebhooksApi.
* @export
* @interface WebhooksApiPostWebhooksRequest
*/
export interface WebhooksApiPostWebhooksRequest {
/**
*
* @type {WebhooksPostWebhooksRequestBody}
* @memberof WebhooksApiPostWebhooks
*/
readonly postWebhooksRequestBody: WebhooksPostWebhooksRequestBody;
}
/**
* WebhooksApi - object-oriented interface
* @export
* @class WebhooksApi
* @extends {BaseAPI}
*/
export declare class WebhooksApi extends BaseAPI {
/**
* Delete a webhook with the given ID. Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 a webhook with the given ID
* @param {WebhooksApiDeleteWebhookRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhooksApi
*/
deleteWebhook(requestParameters: WebhooksApiDeleteWebhookRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Retrieve a webhook with given ID. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** under the Setup & Administration 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 Retrieve a webhook with given ID
* @param {WebhooksApiGetWebhookRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhooksApi
*/
getWebhook(requestParameters: WebhooksApiGetWebhookRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* List all webhooks belonging to a specific org. Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Webhooks** under the Setup & Administration 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 List all webhooks belonging to a specific org.
* @param {WebhooksApiListWebhooksRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhooksApi
*/
listWebhooks(requestParameters?: WebhooksApiListWebhooksRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Update a specific webhook\'s information. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard. This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource. For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 a specific webhook\'s information.
* @param {WebhooksApiPatchWebhookRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhooksApi
*/
patchWebhook(requestParameters: WebhooksApiPatchWebhookRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Create a webhook Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Webhooks** under the Setup & Administration 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 webhook
* @param {WebhooksApiPostWebhooksRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof WebhooksApi
*/
postWebhooks(requestParameters: WebhooksApiPostWebhooksRequest, options?: RawAxiosRequestConfig): Promise>;
}