@eritikass/paring-house-api
v0.1.11@eritikass/paring-house-api
paringHouseApi - JavaScript client for @eritikass/paring-house-api Invoicing system for a parking house 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 @eritikass/paring-house-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 @eritikass/paring-house-api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('@eritikass/paring-house-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/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --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 paringHouseApi = require('@eritikass/paring-house-api');
var api = new paringHouseApi.ClientApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.clientsGet(callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:3857/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
paringHouseApi.ClientApi | clientsGet | GET /clients | get clients list |
paringHouseApi.ClientApi | exportClientIdYearMonthGet | GET /export/{clientId}/{year}/{month} | get client invoice for given month |
paringHouseApi.ParkingApi | parkingClientIdGet | GET /parking/{clientId} | list parkings for client |
paringHouseApi.ParkingApi | parkingPost | POST /parking | enter parking event |
Documentation for Models
- paringHouseApi.ApiResponse
- paringHouseApi.Client
- paringHouseApi.Parking
- paringHouseApi.ParkingInvoice
Documentation for Authorization
All endpoints do not require authorization.
Metadata
- Unlicense
- Whatever
- Unknown
- released 10/8/2017