guest_checkin_rest_api v0.0.1
guest_checkin_rest_api
GuestCheckinRestApi - JavaScript client for guest_checkin_rest_api Communicate with the Guest Checkin backend using this API. This SDK is automatically generated by the Swagger Codegen project:
- API version: API 0.0.1
- Package version: API 0.0.1
- Build package: io.swagger.codegen.v3.generators.javascript.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 guest_checkin_rest_api --save
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):
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 GuestCheckinRestApi = require('guest_checkin_rest_api');
var api = new GuestCheckinRestApi.CheckinControllerApi()
var body = new GuestCheckinRestApi.CheckinForm(); // {CheckinForm} form
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.addVisitUsingPOST(body, callback);
Documentation for API Endpoints
All URIs are relative to //gc.int.skysail.io/
Class | Method | HTTP request | Description |
---|---|---|---|
GuestCheckinRestApi.CheckinControllerApi | addVisitUsingPOST | POST /checkins | adds a customers checkin to this restaurant if valid |
GuestCheckinRestApi.RegistrationControllerApi | addRestaurantUsingPOST1 | POST /register | creates an account, i.e. a user and a restaurant for given input. Fails if users email address already exists. |
GuestCheckinRestApi.RestaurantsControllerApi | addRestaurantUsingPOST2 | POST /restaurants | adds a restaurant for given input. If no user with this email exists, she will be created. |
GuestCheckinRestApi.RestaurantsControllerApi | getUsersUsingGET | GET /restaurants | list current restaurants. |
Documentation for Models
- GuestCheckinRestApi.AddRestaurantsCmd
- GuestCheckinRestApi.CheckinForm
- GuestCheckinRestApi.LoginForm
- GuestCheckinRestApi.RegistrationForm
- GuestCheckinRestApi.RestaurantRow
- GuestCheckinRestApi.SeqRestaurantRow
Documentation for Authorization
All endpoints do not require authorization.
4 years ago