/**
* 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 { ContactResponse } from '../samsara-models';
import { CreateContactRequest } from '../samsara-models';
import { ListContactsResponse } from '../samsara-models';
import { UpdateContactRequest } from '../samsara-models';
/**
* ContactsApi - axios parameter creator
* @export
*/
export declare const ContactsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Add a contact to the organization. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Create a contact
* @param {CreateContactRequest} contact The contact create parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createContact: (contact: CreateContactRequest, options?: RawAxiosRequestConfig) => Promise;
/**
* Delete the given contact. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Delete a contact
* @param {string} id Unique identifier for the contact.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteContact: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Get a specific contact\'s information. **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. To use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Retrieve a contact
* @param {string} id Unique identifier for the contact.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContact: (id: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a list of all contacts in an organization. **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. To use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary List all contacts
* @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}
*/
listContacts: (limit?: number, after?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Update a specific contact\'s information. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Update a contact
* @param {string} id Unique identifier for the contact.
* @param {UpdateContactRequest} contact Updates to the contact.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateContact: (id: string, contact: UpdateContactRequest, options?: RawAxiosRequestConfig) => Promise;
};
/**
* ContactsApi - functional programming interface
* @export
*/
export declare const ContactsApiFp: (configuration?: Configuration) => {
/**
* Add a contact to the organization. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Create a contact
* @param {CreateContactRequest} contact The contact create parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createContact(contact: CreateContactRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Delete the given contact. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Delete a contact
* @param {string} id Unique identifier for the contact.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteContact(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Get a specific contact\'s information. **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. To use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Retrieve a contact
* @param {string} id Unique identifier for the contact.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContact(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a list of all contacts in an organization. **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. To use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary List all contacts
* @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}
*/
listContacts(limit?: number, after?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Update a specific contact\'s information. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Update a contact
* @param {string} id Unique identifier for the contact.
* @param {UpdateContactRequest} contact Updates to the contact.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateContact(id: string, contact: UpdateContactRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* ContactsApi - factory interface
* @export
*/
export declare const ContactsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Add a contact to the organization. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Create a contact
* @param {ContactsApiCreateContactRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createContact(requestParameters: ContactsApiCreateContactRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Delete the given contact. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Delete a contact
* @param {ContactsApiDeleteContactRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteContact(requestParameters: ContactsApiDeleteContactRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Get a specific contact\'s information. **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. To use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Retrieve a contact
* @param {ContactsApiGetContactRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getContact(requestParameters: ContactsApiGetContactRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list of all contacts in an organization. **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. To use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary List all contacts
* @param {ContactsApiListContactsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
listContacts(requestParameters?: ContactsApiListContactsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Update a specific contact\'s information. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Update a contact
* @param {ContactsApiUpdateContactRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateContact(requestParameters: ContactsApiUpdateContactRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for createContact operation in ContactsApi.
* @export
* @interface ContactsApiCreateContactRequest
*/
export interface ContactsApiCreateContactRequest {
/**
* The contact create parameters.
* @type {CreateContactRequest}
* @memberof ContactsApiCreateContact
*/
readonly contact: CreateContactRequest;
}
/**
* Request parameters for deleteContact operation in ContactsApi.
* @export
* @interface ContactsApiDeleteContactRequest
*/
export interface ContactsApiDeleteContactRequest {
/**
* Unique identifier for the contact.
* @type {string}
* @memberof ContactsApiDeleteContact
*/
readonly id: string;
}
/**
* Request parameters for getContact operation in ContactsApi.
* @export
* @interface ContactsApiGetContactRequest
*/
export interface ContactsApiGetContactRequest {
/**
* Unique identifier for the contact.
* @type {string}
* @memberof ContactsApiGetContact
*/
readonly id: string;
}
/**
* Request parameters for listContacts operation in ContactsApi.
* @export
* @interface ContactsApiListContactsRequest
*/
export interface ContactsApiListContactsRequest {
/**
* The limit for how many objects will be in the response. Default and max for this value is 512 objects.
* @type {number}
* @memberof ContactsApiListContacts
*/
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 ContactsApiListContacts
*/
readonly after?: string;
}
/**
* Request parameters for updateContact operation in ContactsApi.
* @export
* @interface ContactsApiUpdateContactRequest
*/
export interface ContactsApiUpdateContactRequest {
/**
* Unique identifier for the contact.
* @type {string}
* @memberof ContactsApiUpdateContact
*/
readonly id: string;
/**
* Updates to the contact.
* @type {UpdateContactRequest}
* @memberof ContactsApiUpdateContact
*/
readonly contact: UpdateContactRequest;
}
/**
* ContactsApi - object-oriented interface
* @export
* @class ContactsApi
* @extends {BaseAPI}
*/
export declare class ContactsApi extends BaseAPI {
/**
* Add a contact to the organization. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Create a contact
* @param {ContactsApiCreateContactRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ContactsApi
*/
createContact(requestParameters: ContactsApiCreateContactRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Delete the given contact. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Delete a contact
* @param {ContactsApiDeleteContactRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ContactsApi
*/
deleteContact(requestParameters: ContactsApiDeleteContactRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Get a specific contact\'s information. **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. To use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Retrieve a contact
* @param {ContactsApiGetContactRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ContactsApi
*/
getContact(requestParameters: ContactsApiGetContactRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a list of all contacts in an organization. **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. To use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary List all contacts
* @param {ContactsApiListContactsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ContactsApi
*/
listContacts(requestParameters?: ContactsApiListContactsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* Update a specific contact\'s information. **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. To use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. Learn More.
* @summary Update a contact
* @param {ContactsApiUpdateContactRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ContactsApi
*/
updateContact(requestParameters: ContactsApiUpdateContactRequest, options?: RawAxiosRequestConfig): Promise>;
}