/**
* 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 { TrainingCourseObjectResponseBody } from './training-course-object-response-body';
import { TrainingLearnerObjectResponseBody } from './training-learner-object-response-body';
/**
* Training Assignment response object.
* @export
* @interface TrainingAssignmentResponseObjectResponseBody
*/
export interface TrainingAssignmentResponseObjectResponseBody {
/**
* Time training assignment is completed. UTC timestamp in RFC 3339 format. Returned when a training assignment completion status is \"complete\".
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'completedAtTime'?: string;
/**
*
* @type {TrainingCourseObjectResponseBody}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'course': TrainingCourseObjectResponseBody;
/**
* Creation time of the training assignment. UTC timestamp in RFC 3339 format.
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'createdAtTime': string;
/**
* ID of the user who created the training assignment.
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'createdById': string;
/**
* Time training assignment is deleted. UTC timestamp in RFC 3339 format.
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'deletedAtTime'?: string;
/**
* Time training assignment is due. UTC timestamp in RFC 3339 format. Returned when an assignment has a due date set by an admin.
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'dueAtTime'?: string;
/**
* Time spent on the training assignment.
* @type {number}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'durationMinutes': number;
/**
* ID of the training assignment.
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'id': string;
/**
* Indicates whether the training assignment was completed on time or not. Returned when a training assignment completion status is \"complete\" and has a dueAtTime set by an admin.
* @type {boolean}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'isCompletedLate'?: boolean;
/**
* Indicates whether the training assignment is past the due date. Returned when a training assignment completion status is \'inProgress\' or \'notStarted\' and has a dueAtTime set by an admin.
* @type {boolean}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'isOverdue'?: boolean;
/**
*
* @type {TrainingLearnerObjectResponseBody}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'learner': TrainingLearnerObjectResponseBody;
/**
* Quiz score associated with training assignment. Returned when a training assignment completion status is \"complete\".
* @type {number}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'scorePercent'?: number;
/**
* Time training assignment is started. UTC timestamp in RFC 3339 format. Returned when a training assignment completion status is \"complete\" or \"inProgress\".
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'startedAtTime'?: string;
/**
* State for the Training Assignment. Always returned. Valid values: `notStarted`, `inProgress`, `completed`
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'status': TrainingAssignmentResponseObjectResponseBodyStatusEnum;
/**
* Time training assignment was updated by either a learner or an admin. UTC timestamp in RFC 3339 format.
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'updatedAtTime': string;
/**
* ID of the user who updated the training assignment, either an admin or a learner.
* @type {string}
* @memberof TrainingAssignmentResponseObjectResponseBody
*/
'updatedById': string;
}
export declare const TrainingAssignmentResponseObjectResponseBodyStatusEnum: {
readonly NotStarted: "notStarted";
readonly InProgress: "inProgress";
readonly Completed: "completed";
};
export type TrainingAssignmentResponseObjectResponseBodyStatusEnum = typeof TrainingAssignmentResponseObjectResponseBodyStatusEnum[keyof typeof TrainingAssignmentResponseObjectResponseBodyStatusEnum];