0.0.1 • Published 3 years ago

de.wheres_my_thief.api v0.0.1

Weekly downloads
-
License
Unlicense
Repository
-
Last release
3 years ago

wheres_my_thief___api

WheresMyThiefApi - JavaScript client for wheres_my_thief___api API zur Webanwendung This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: v1
  • 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 wheres_my_thief___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 wheres_my_thief___api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('wheres_my_thief___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/wheres_my_thief___api then install it via:

    npm install YOUR_USERNAME/wheres_my_thief___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 WheresMyThiefApi = require('wheres_my_thief___api');

var api = new WheresMyThiefApi.DevicesApi()

var device = new WheresMyThiefApi.Device(); // {Device} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addDevice(device, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:5000/v1

ClassMethodHTTP requestDescription
WheresMyThiefApi.DevicesApiaddDevicePOST /devicesadd Device
WheresMyThiefApi.DevicesApidevicesIMEIDeleteDELETE /devices/{IMEI}
WheresMyThiefApi.DevicesApidevicesIMEIGetGET /devices/{IMEI}get Device by ID
WheresMyThiefApi.DevicesApidevicesIMEILocationsDeleteDELETE /devices/{IMEI}/locations
WheresMyThiefApi.DevicesApidevicesIMEILocationsGetGET /devices/{IMEI}/locationsGet Locations of device
WheresMyThiefApi.DevicesApidevicesIMEILocationsPostPOST /devices/{IMEI}/locationsadd GPS-Position to Device
WheresMyThiefApi.UsersApicreateUserPOST /userscreate new User
WheresMyThiefApi.UsersApifindAllDevicesGET /users/{userId}/devicesget Devices from User
WheresMyThiefApi.UsersApigetUserbyIdGET /users/{userId}get User by ID
WheresMyThiefApi.UsersApiloginUserPOST /users/loginlogin User
WheresMyThiefApi.UsersApiupdateUserPUT /users/{userId}Update User
WheresMyThiefApi.UsersApiusersLogoutPostPOST /users/logoutlogout user
WheresMyThiefApi.UsersApiusersUserIdDeleteDELETE /users/{userId}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.