Socket
Socket
Sign inDemoInstall

travel_tracker_swagger_api

Package Overview
Dependencies
38
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

travel_tracker_swagger_api

Travel_Tracker_swagger_API_documentation_


Version published
Maintainers
1
Weekly downloads
4

Weekly downloads

Readme

Source

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/

ClassMethodHTTP requestDescription
TravelTrackerSwaggerApi.AccountApiinitializeGET /account/init
TravelTrackerSwaggerApi.AccountApilogoutGET /account/logout
TravelTrackerSwaggerApi.AccountApirecoverGET /account/recover/{loginid}
TravelTrackerSwaggerApi.AccountApisigninPOST /account/signin
TravelTrackerSwaggerApi.AccountApisignupPOST /account/signup
TravelTrackerSwaggerApi.AccountApiverifyGET /account/verify/{contact}/{code}
TravelTrackerSwaggerApi.PurposeApicreatePurposePOST /purposes
TravelTrackerSwaggerApi.PurposeApideletePurposeDELETE /purposes/{id}
TravelTrackerSwaggerApi.PurposeApipurposeGET /purposes/{id}
TravelTrackerSwaggerApi.PurposeApipurposesGET /purposes
TravelTrackerSwaggerApi.PurposeApiupdatePurposePUT /purposes
TravelTrackerSwaggerApi.TripApiaddReadingPOST /trips/reading
TravelTrackerSwaggerApi.TripApiaddTripPOST /trips
TravelTrackerSwaggerApi.TripApideleteTripDELETE /trips/{id}
TravelTrackerSwaggerApi.TripApigetLatestTripGET /trips/latest
TravelTrackerSwaggerApi.TripApigetTripsForPurposeGET /trips/purposes/{id}
TravelTrackerSwaggerApi.TripApigetTripsInRangeGET /trips
TravelTrackerSwaggerApi.TripApigetTripsOfVehicleGET /trips/vehicles/{id}
TravelTrackerSwaggerApi.TripApishareTripPOST /trips/share
TravelTrackerSwaggerApi.TripApiupdateTripPUT /trips
TravelTrackerSwaggerApi.VehicleApicreateVehiclePOST /vehicles
TravelTrackerSwaggerApi.VehicleApideleteVehicleDELETE /vehicles/:vid
TravelTrackerSwaggerApi.VehicleApigetRecentGET /vehicles/latest
TravelTrackerSwaggerApi.VehicleApigetVehicleGET /vehicles/{vid}
TravelTrackerSwaggerApi.VehicleApilistVehiclesGET /vehicles
TravelTrackerSwaggerApi.VehicleApiupdateVehiclePUT /vehicles
TravelTrackerSwaggerApi.VersionApicheckLatestGET /versions/check/:version
TravelTrackerSwaggerApi.VersionApicreateVersionPOST /versions
TravelTrackerSwaggerApi.VersionApideleteVersionDELETE /versions/:vid
TravelTrackerSwaggerApi.VersionApiupdateVersionPUT /versions
TravelTrackerSwaggerApi.VersionApiversionGET /versions/:vid
TravelTrackerSwaggerApi.VersionApiversionsGET /versions

Documentation for Models

Documentation for Authorization

BasicAuth

  • Type: HTTP basic authentication

api_key

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

FAQs

Last updated on 01 May 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc