/**
* 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 { GatewaysGetGatewaysResponseBody } from '../samsara-models';
import { GatewaysPostGatewayRequestBody } from '../samsara-models';
import { GatewaysPostGatewayResponseBody } from '../samsara-models';
/**
* GatewaysApi - axios parameter creator
* @export
*/
export declare const GatewaysApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Deactivate a gateway Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Gateways** 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 Deactivate a gateway
* @param {string} id Gateway serial number
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteGateway: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* List all gateways Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Gateways** 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 gateways
* @param {Array} [models] Filter by a comma separated list of gateway models.
* @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}
*/
getGateways: (models?: Array, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Activate a new gateway. To activate a device and associate it with your organization, enter its serial number. Each device\'s serial number can also be found on its label or packaging, or from your order confirmation email. A Not Found error could mean that the serial was not found or it has already been activated Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Gateways** 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 Activate a new gateway
* @param {GatewaysPostGatewayRequestBody} postGatewayRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postGateway: (postGatewayRequestBody: GatewaysPostGatewayRequestBody, options?: RawAxiosRequestConfig) => Promise;
};
/**
* GatewaysApi - functional programming interface
* @export
*/
export declare const GatewaysApiFp: (configuration?: Configuration) => {
/**
* Deactivate a gateway Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Gateways** 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 Deactivate a gateway
* @param {string} id Gateway serial number
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteGateway(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* List all gateways Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Gateways** 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 gateways
* @param {Array} [models] Filter by a comma separated list of gateway models.
* @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}
*/
getGateways(models?: Array, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Activate a new gateway. To activate a device and associate it with your organization, enter its serial number. Each device\'s serial number can also be found on its label or packaging, or from your order confirmation email. A Not Found error could mean that the serial was not found or it has already been activated Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Gateways** 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 Activate a new gateway
* @param {GatewaysPostGatewayRequestBody} postGatewayRequestBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postGateway(postGatewayRequestBody: GatewaysPostGatewayRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* GatewaysApi - factory interface
* @export
*/
export declare const GatewaysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Deactivate a gateway Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Gateways** 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 Deactivate a gateway
* @param {GatewaysApiDeleteGatewayRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteGateway(requestParameters: GatewaysApiDeleteGatewayRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* List all gateways Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Gateways** 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 gateways
* @param {GatewaysApiGetGatewaysRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getGateways(requestParameters?: GatewaysApiGetGatewaysRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Activate a new gateway. To activate a device and associate it with your organization, enter its serial number. Each device\'s serial number can also be found on its label or packaging, or from your order confirmation email. A Not Found error could mean that the serial was not found or it has already been activated Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Gateways** 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 Activate a new gateway
* @param {GatewaysApiPostGatewayRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postGateway(requestParameters: GatewaysApiPostGatewayRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for deleteGateway operation in GatewaysApi.
* @export
* @interface GatewaysApiDeleteGatewayRequest
*/
export interface GatewaysApiDeleteGatewayRequest {
/**
* Gateway serial number
* @type {string}
* @memberof GatewaysApiDeleteGateway
*/
readonly id: string;
}
/**
* Request parameters for getGateways operation in GatewaysApi.
* @export
* @interface GatewaysApiGetGatewaysRequest
*/
export interface GatewaysApiGetGatewaysRequest {
/**
* Filter by a comma separated list of gateway models.
* @type {Array}
* @memberof GatewaysApiGetGateways
*/
readonly models?: Array;
/**
* 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 GatewaysApiGetGateways
*/
readonly after?: string;
}
/**
* Request parameters for postGateway operation in GatewaysApi.
* @export
* @interface GatewaysApiPostGatewayRequest
*/
export interface GatewaysApiPostGatewayRequest {
/**
*
* @type {GatewaysPostGatewayRequestBody}
* @memberof GatewaysApiPostGateway
*/
readonly postGatewayRequestBody: GatewaysPostGatewayRequestBody;
}
/**
* GatewaysApi - object-oriented interface
* @export
* @class GatewaysApi
* @extends {BaseAPI}
*/
export declare class GatewaysApi extends BaseAPI {
/**
* Deactivate a gateway Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Gateways** 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 Deactivate a gateway
* @param {GatewaysApiDeleteGatewayRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GatewaysApi
*/
deleteGateway(requestParameters: GatewaysApiDeleteGatewayRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* List all gateways Rate limit: 5 requests/sec (learn more about rate limits here). To use this endpoint, select **Read Gateways** 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 gateways
* @param {GatewaysApiGetGatewaysRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GatewaysApi
*/
getGateways(requestParameters?: GatewaysApiGetGatewaysRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Activate a new gateway. To activate a device and associate it with your organization, enter its serial number. Each device\'s serial number can also be found on its label or packaging, or from your order confirmation email. A Not Found error could mean that the serial was not found or it has already been activated Rate limit: 100 requests/min (learn more about rate limits here). To use this endpoint, select **Write Gateways** 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 Activate a new gateway
* @param {GatewaysApiPostGatewayRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GatewaysApi
*/
postGateway(requestParameters: GatewaysApiPostGatewayRequest, options?: RawAxiosRequestConfig): Promise>;
}