travel_tracker_swagger_api v1.3.5
travel_tracker_swagger_api
TravelTrackerSwaggerApi - JavaScript client for travel_tracker_swagger_api Travel Tracker swagger API documentation. This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install travel_tracker_swagger_api --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your travel_tracker_swagger_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('travel_tracker_swagger_api')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/travel_tracker_swagger_api then install it via:
npm install YOUR_USERNAME/travel_tracker_swagger_api --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually
use this library):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var TravelTrackerSwaggerApi = require('travel_tracker_swagger_api');
var defaultClient = TravelTrackerSwaggerApi.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['Authorization'] = "Token"
var api = new TravelTrackerSwaggerApi.AccountApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.initialize(callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:3000/api/v1/
Class | Method | HTTP request | Description |
---|---|---|---|
TravelTrackerSwaggerApi.AccountApi | initialize | GET /account/init | |
TravelTrackerSwaggerApi.AccountApi | logout | GET /account/logout | |
TravelTrackerSwaggerApi.AccountApi | recover | GET /account/recover/{loginid} | |
TravelTrackerSwaggerApi.AccountApi | signin | POST /account/signin | |
TravelTrackerSwaggerApi.AccountApi | signup | POST /account/signup | |
TravelTrackerSwaggerApi.AccountApi | verify | GET /account/verify/{contact}/{code} | |
TravelTrackerSwaggerApi.PurposeApi | createPurpose | POST /purposes | |
TravelTrackerSwaggerApi.PurposeApi | deletePurpose | DELETE /purposes/{id} | |
TravelTrackerSwaggerApi.PurposeApi | purpose | GET /purposes/{id} | |
TravelTrackerSwaggerApi.PurposeApi | purposes | GET /purposes | |
TravelTrackerSwaggerApi.PurposeApi | updatePurpose | PUT /purposes | |
TravelTrackerSwaggerApi.TripApi | addReading | POST /trips/reading | |
TravelTrackerSwaggerApi.TripApi | addTrip | POST /trips | |
TravelTrackerSwaggerApi.TripApi | deleteTrip | DELETE /trips/{id} | |
TravelTrackerSwaggerApi.TripApi | getLatestTrip | GET /trips/latest | |
TravelTrackerSwaggerApi.TripApi | getTripsForPurpose | GET /trips/purposes/{id} | |
TravelTrackerSwaggerApi.TripApi | getTripsInRange | GET /trips | |
TravelTrackerSwaggerApi.TripApi | getTripsOfVehicle | GET /trips/vehicles/{id} | |
TravelTrackerSwaggerApi.TripApi | shareTrip | POST /trips/share | |
TravelTrackerSwaggerApi.TripApi | updateTrip | PUT /trips | |
TravelTrackerSwaggerApi.VehicleApi | createVehicle | POST /vehicles | |
TravelTrackerSwaggerApi.VehicleApi | deleteVehicle | DELETE /vehicles/:vid | |
TravelTrackerSwaggerApi.VehicleApi | getRecent | GET /vehicles/latest | |
TravelTrackerSwaggerApi.VehicleApi | getVehicle | GET /vehicles/{vid} | |
TravelTrackerSwaggerApi.VehicleApi | listVehicles | GET /vehicles | |
TravelTrackerSwaggerApi.VehicleApi | updateVehicle | PUT /vehicles | |
TravelTrackerSwaggerApi.VersionApi | checkLatest | GET /versions/check/:version | |
TravelTrackerSwaggerApi.VersionApi | createVersion | POST /versions | |
TravelTrackerSwaggerApi.VersionApi | deleteVersion | DELETE /versions/:vid | |
TravelTrackerSwaggerApi.VersionApi | updateVersion | PUT /versions | |
TravelTrackerSwaggerApi.VersionApi | version | GET /versions/:vid | |
TravelTrackerSwaggerApi.VersionApi | versions | GET /versions |
Documentation for Models
- TravelTrackerSwaggerApi.BasicToken
- TravelTrackerSwaggerApi.Coords
- TravelTrackerSwaggerApi.Error
- TravelTrackerSwaggerApi.LoginModel
- TravelTrackerSwaggerApi.Purpose
- TravelTrackerSwaggerApi.Reading
- TravelTrackerSwaggerApi.Recovery
- TravelTrackerSwaggerApi.Success
- TravelTrackerSwaggerApi.Trip
- TravelTrackerSwaggerApi.TripShare
- TravelTrackerSwaggerApi.User
- TravelTrackerSwaggerApi.UserLocation
- TravelTrackerSwaggerApi.Vehicle
- TravelTrackerSwaggerApi.Version
- TravelTrackerSwaggerApi.VersionStatus
Documentation for Authorization
BasicAuth
- Type: HTTP basic authentication
api_key
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header