route4me-nodejs-sdk/src/resources/vehicles.js

Access Route4Me's logistics-as-a-service API using our Node.js SDK

"use strict"

/**
 * @deprecated since version 1.0.23
 * @see {@link VehiclesV5.html VehiclesV5}
 *
 * Vehicles facility
 *
 * @category Vehicles
 */
class Vehicles {
	/**
	 * @deprecated since version 1.0.23
	 * @see {@link VehiclesV5.html#new_VehiclesV5_new VehiclesV5}
	 *
	 * Constructor
	 *
	 * @see {@link https://route4me.io/docs/#vehicles}
	 * @since 0.1.4
	 * @private
	 *
	 * @param  {RequestManager} requestManager - Request Manager
	 * @return {Vehicles}					  - Vehicles facility
	 */
	constructor(requestManager) {
		this.r = requestManager
	}

	/**
	 * @deprecated since version 1.0.23
	 * @see {@link VehiclesV5.html#VehiclesV5+list VehiclesV5.list}
	 *
	 * Get vehicles that belong to the Route4Me account
	 *
	 * @todo Fix error in API docs: there the method utilizes `POST`-http-method to get results
	 *
	 * @see {@link https://route4me.io/docs/#get-vehicles}
	 *
	 * @param {module:route4me-node~RequestCallback<jsonschema:Vehicles.ResponseMany>} [callback]
	 */
	list(callback) {
		return this.r._makeRequest({
			method: "GET",
			path: "/api.v4/vehicle.php",
			validationContext: "Vehicles.ResponseMany",
		}, callback)
	}
}

module.exports = Vehicles