npm.io
1.0.2 • Published 8 years ago

serverproto

Licence
Apache-2.0
Version
1.0.2
Deps
1
Vulns
1
Weekly
0

serverproto

Serverproto - JavaScript client for serverproto No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.1
  • Package version: 1.0.1
  • Build package: class 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 serverproto --save
git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/serverproto then install it via:

    npm install YOUR_USERNAME/serverproto --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):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var Serverproto = require('serverproto');

var api = new Serverproto.ApiApi()

var body = new Serverproto.Customer(); // {Customer} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCustomer(body, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
Serverproto.ApiApi addCustomer POST /v1/admin/customer
Serverproto.ApiApi addInventory POST /v1/admin/inventory
Serverproto.ApiApi addProduct POST /v1/admin/product
Serverproto.ApiApi addUser POST /v1/admin/user
Serverproto.ApiApi adminLogin POST /v1/login_admin
Serverproto.ApiApi customerAnalytics POST /v1/secure/analytics
Serverproto.ApiApi customerAnalyticsRevenue POST /v1/secure/analytics/revenue
Serverproto.ApiApi customers POST /v1/admin/customers
Serverproto.ApiApi disableCustomer POST /v1/admin/customer/disable/{id}
Serverproto.ApiApi disableInsurance POST /v1/secure/insurance/off
Serverproto.ApiApi enableCustomer POST /v1/admin/customer/enable/{id}
Serverproto.ApiApi enableInsurance POST /v1/secure/insurance/on
Serverproto.ApiApi getUser POST /v1/admin/user/{id}
Serverproto.ApiApi insurances POST /v1/secure/insurances
Serverproto.ApiApi inventory POST /v1/secure/inventory
Serverproto.ApiApi inventoryPAR POST /v1/secure/inventory/par
Serverproto.ApiApi login POST /v1/login
Serverproto.ApiApi products POST /v1/secure/products
Serverproto.ApiApi registerSale POST /v1/secure/sale
Serverproto.ApiApi removeCustomer DELETE /v1/admin/customer/{id}
Serverproto.ApiApi removeProduct DELETE /v1/admin/product/{id}
Serverproto.ApiApi removeUser DELETE /v1/admin/user/{id}
Serverproto.ApiApi updateCustomer PATCH /v1/admin/customer
Serverproto.ApiApi updateProduct PATCH /v1/admin/product
Serverproto.ApiApi updateUser PATCH /v1/admin/user
Serverproto.ApiApi users POST /v1/admin/users

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.