/**
* 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 { InlineResponse2007 } from '../samsara-models';
import { V1TrailerAssignmentsResponse } from '../samsara-models';
/**
* TrailerAssignmentsApi - axios parameter creator
* @export
*/
export declare const TrailerAssignmentsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* This endpoint is still on our legacy API. Fetch trailer assignment data for all trailers in your organization. Rate limit: 100 requests/sec (learn more about rate limits here). **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 Assignments** under the Assignments category when creating or editing an API token. Learn More.
* @summary List trailer assignments for all trailers
* @param {number} [startMs] Timestamp in Unix epoch miliseconds representing the start of the period to fetch. Omitting both startMs and endMs only returns current assignments.
* @param {number} [endMs] Timestamp in Unix epoch miliseconds representing the end of the period to fetch. Omitting endMs sets endMs as the current time
* @param {number} [limit] Pagination parameter indicating the number of results to return in this request. Used in conjunction with either \'startingAfter\' or \'endingBefore\'.
* @param {string} [startingAfter] Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the \'limit\' parameter. Mutually exclusive with \'endingBefore\' parameter.
* @param {string} [endingBefore] Pagination parameter indicating the cursor position to return results before. Used in conjunction with the \'limit\' parameter. Mutually exclusive with \'startingAfter\' parameter.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getAllTrailerAssignments: (startMs?: number, endMs?: number, limit?: number, startingAfter?: string, endingBefore?: string, options?: RawAxiosRequestConfig) => Promise;
/**
* This endpoint is still on our legacy API. Fetch trailer assignment data for a single trailer. Rate limit: 100 requests/sec (learn more about rate limits here). **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 Assignments** under the Assignments category when creating or editing an API token. Learn More.
* @summary List trailer assignments for a given trailer
* @param {number} trailerId ID of trailer. Must contain only digits 0-9.
* @param {number} [startMs] Timestamp in Unix epoch milliseconds representing the start of the period to fetch. Omitting both startMs and endMs only returns current assignments.
* @param {number} [endMs] Timestamp in Unix epoch milliseconds representing the end of the period to fetch. Omitting endMs sets endMs as the current time
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getFleetTrailerAssignments: (trailerId: number, startMs?: number, endMs?: number, options?: RawAxiosRequestConfig) => Promise;
};
/**
* TrailerAssignmentsApi - functional programming interface
* @export
*/
export declare const TrailerAssignmentsApiFp: (configuration?: Configuration) => {
/**
* This endpoint is still on our legacy API. Fetch trailer assignment data for all trailers in your organization. Rate limit: 100 requests/sec (learn more about rate limits here). **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 Assignments** under the Assignments category when creating or editing an API token. Learn More.
* @summary List trailer assignments for all trailers
* @param {number} [startMs] Timestamp in Unix epoch miliseconds representing the start of the period to fetch. Omitting both startMs and endMs only returns current assignments.
* @param {number} [endMs] Timestamp in Unix epoch miliseconds representing the end of the period to fetch. Omitting endMs sets endMs as the current time
* @param {number} [limit] Pagination parameter indicating the number of results to return in this request. Used in conjunction with either \'startingAfter\' or \'endingBefore\'.
* @param {string} [startingAfter] Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the \'limit\' parameter. Mutually exclusive with \'endingBefore\' parameter.
* @param {string} [endingBefore] Pagination parameter indicating the cursor position to return results before. Used in conjunction with the \'limit\' parameter. Mutually exclusive with \'startingAfter\' parameter.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getAllTrailerAssignments(startMs?: number, endMs?: number, limit?: number, startingAfter?: string, endingBefore?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* This endpoint is still on our legacy API. Fetch trailer assignment data for a single trailer. Rate limit: 100 requests/sec (learn more about rate limits here). **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 Assignments** under the Assignments category when creating or editing an API token. Learn More.
* @summary List trailer assignments for a given trailer
* @param {number} trailerId ID of trailer. Must contain only digits 0-9.
* @param {number} [startMs] Timestamp in Unix epoch milliseconds representing the start of the period to fetch. Omitting both startMs and endMs only returns current assignments.
* @param {number} [endMs] Timestamp in Unix epoch milliseconds representing the end of the period to fetch. Omitting endMs sets endMs as the current time
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getFleetTrailerAssignments(trailerId: number, startMs?: number, endMs?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* TrailerAssignmentsApi - factory interface
* @export
*/
export declare const TrailerAssignmentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* This endpoint is still on our legacy API. Fetch trailer assignment data for all trailers in your organization. Rate limit: 100 requests/sec (learn more about rate limits here). **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 Assignments** under the Assignments category when creating or editing an API token. Learn More.
* @summary List trailer assignments for all trailers
* @param {TrailerAssignmentsApiV1getAllTrailerAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getAllTrailerAssignments(requestParameters?: TrailerAssignmentsApiV1getAllTrailerAssignmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* This endpoint is still on our legacy API. Fetch trailer assignment data for a single trailer. Rate limit: 100 requests/sec (learn more about rate limits here). **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 Assignments** under the Assignments category when creating or editing an API token. Learn More.
* @summary List trailer assignments for a given trailer
* @param {TrailerAssignmentsApiV1getFleetTrailerAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
v1getFleetTrailerAssignments(requestParameters: TrailerAssignmentsApiV1getFleetTrailerAssignmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* Request parameters for v1getAllTrailerAssignments operation in TrailerAssignmentsApi.
* @export
* @interface TrailerAssignmentsApiV1getAllTrailerAssignmentsRequest
*/
export interface TrailerAssignmentsApiV1getAllTrailerAssignmentsRequest {
/**
* Timestamp in Unix epoch miliseconds representing the start of the period to fetch. Omitting both startMs and endMs only returns current assignments.
* @type {number}
* @memberof TrailerAssignmentsApiV1getAllTrailerAssignments
*/
readonly startMs?: number;
/**
* Timestamp in Unix epoch miliseconds representing the end of the period to fetch. Omitting endMs sets endMs as the current time
* @type {number}
* @memberof TrailerAssignmentsApiV1getAllTrailerAssignments
*/
readonly endMs?: number;
/**
* Pagination parameter indicating the number of results to return in this request. Used in conjunction with either \'startingAfter\' or \'endingBefore\'.
* @type {number}
* @memberof TrailerAssignmentsApiV1getAllTrailerAssignments
*/
readonly limit?: number;
/**
* Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the \'limit\' parameter. Mutually exclusive with \'endingBefore\' parameter.
* @type {string}
* @memberof TrailerAssignmentsApiV1getAllTrailerAssignments
*/
readonly startingAfter?: string;
/**
* Pagination parameter indicating the cursor position to return results before. Used in conjunction with the \'limit\' parameter. Mutually exclusive with \'startingAfter\' parameter.
* @type {string}
* @memberof TrailerAssignmentsApiV1getAllTrailerAssignments
*/
readonly endingBefore?: string;
}
/**
* Request parameters for v1getFleetTrailerAssignments operation in TrailerAssignmentsApi.
* @export
* @interface TrailerAssignmentsApiV1getFleetTrailerAssignmentsRequest
*/
export interface TrailerAssignmentsApiV1getFleetTrailerAssignmentsRequest {
/**
* ID of trailer. Must contain only digits 0-9.
* @type {number}
* @memberof TrailerAssignmentsApiV1getFleetTrailerAssignments
*/
readonly trailerId: number;
/**
* Timestamp in Unix epoch milliseconds representing the start of the period to fetch. Omitting both startMs and endMs only returns current assignments.
* @type {number}
* @memberof TrailerAssignmentsApiV1getFleetTrailerAssignments
*/
readonly startMs?: number;
/**
* Timestamp in Unix epoch milliseconds representing the end of the period to fetch. Omitting endMs sets endMs as the current time
* @type {number}
* @memberof TrailerAssignmentsApiV1getFleetTrailerAssignments
*/
readonly endMs?: number;
}
/**
* TrailerAssignmentsApi - object-oriented interface
* @export
* @class TrailerAssignmentsApi
* @extends {BaseAPI}
*/
export declare class TrailerAssignmentsApi extends BaseAPI {
/**
* This endpoint is still on our legacy API. Fetch trailer assignment data for all trailers in your organization. Rate limit: 100 requests/sec (learn more about rate limits here). **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 Assignments** under the Assignments category when creating or editing an API token. Learn More.
* @summary List trailer assignments for all trailers
* @param {TrailerAssignmentsApiV1getAllTrailerAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TrailerAssignmentsApi
*/
v1getAllTrailerAssignments(requestParameters?: TrailerAssignmentsApiV1getAllTrailerAssignmentsRequest, options?: RawAxiosRequestConfig): Promise>;
/**
* This endpoint is still on our legacy API. Fetch trailer assignment data for a single trailer. Rate limit: 100 requests/sec (learn more about rate limits here). **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 Assignments** under the Assignments category when creating or editing an API token. Learn More.
* @summary List trailer assignments for a given trailer
* @param {TrailerAssignmentsApiV1getFleetTrailerAssignmentsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TrailerAssignmentsApi
*/
v1getFleetTrailerAssignments(requestParameters: TrailerAssignmentsApiV1getFleetTrailerAssignmentsRequest, options?: RawAxiosRequestConfig): Promise>;
}