<<<<<<< HEAD
GoGoodCheckinApi - JavaScript client for go_good_checkin_api This API allows clients to checkin through the GoGood API This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1
- Package version: 1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
For Node.js
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install go_good_checkin_api --save
Finally, you need to build the module:
npm run build
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
To use the link you just defined in your project, switch to the directory you want to use your go_good_checkin_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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
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.
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
}
}
]
}
Please follow the installation instruction and execute the following JS code:
var GoGoodCheckinApi = require('go_good_checkin_api');
var api = new GoGoodCheckinApi.DefaultApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.checkinHook(callback);
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
GoGoodCheckinApi.DefaultApi | checkinHook | POST //checkin/validate | Validates and checks in an user to a given business |
- GoGoodCheckinApi.CheckinFailedResponse400
- GoGoodCheckinApi.CheckinFailedResponse401
- GoGoodCheckinApi.CheckinFailedResponse500
- GoGoodCheckinApi.CheckinRequest
- GoGoodCheckinApi.CheckinSuccessResponse
Endpoints do not require authorization.
=======
GoGood Checkins Docs
14e99e8ecdbff16832766b8e0fc7ab4edc22397c