qsr_pos_api v0.0.0
qsr_pos_api
QsrPosApi - JavaScript client for qsr_pos_api 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: 0.0.0
- Package version: 0.0.0
- 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 qsr_pos_api --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/qsr_pos_api then install it via:
npm install YOUR_USERNAME/qsr_pos_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):
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 QsrPosApi = require('qsr_pos_api');
var api = new QsrPosApi.DefaultApi()
var checkNumber = 56; // {Number} The check number
var opts = {
'qSRPOSMessageUID': "qSRPOSMessageUID_example" // {String}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.checksCheckNumberCoursesBumpsPost(checkNumber, opts, callback);
Documentation for API Endpoints
All URIs are relative to http://192.168.180.50:32768/pos
Class | Method | HTTP request | Description |
---|---|---|---|
QsrPosApi.DefaultApi | checksCheckNumberCoursesBumpsPost | POST /checks/{check_number}/courses/bumps | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCancellationsPost | POST /checks/{check_number}/courses/cancellations | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberBumpsPost | POST /checks/{check_number}/courses/{course_number}/bumps | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberCancellationsPost | POST /checks/{check_number}/courses/{course_number}/cancellations | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberDelete | DELETE /checks/{check_number}/courses/{course_number} | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberFastTracksPost | POST /checks/{check_number}/courses/{course_number}/fast-tracks | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberItemsItemNumberCancellationsPost | POST /checks/{check_number}/courses/{course_number}/items/{item_number}/cancellations | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberItemsItemNumberFastTracksPost | POST /checks/{check_number}/courses/{course_number}/items/{item_number}/fast-tracks | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberItemsItemNumberPatch | PATCH /checks/{check_number}/courses/{course_number}/items/{item_number} | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberItemsPost | POST /checks/{check_number}/courses/{course_number}/items | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberPatch | PATCH /checks/{check_number}/courses/{course_number} | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesCourseNumberPaymentStatesPost | POST /checks/{check_number}/courses/{course_number}/payment-states | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesFastTracksPost | POST /checks/{check_number}/courses/fast-tracks | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesPatch | PATCH /checks/{check_number}/courses | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesPaymentStatesPost | POST /checks/{check_number}/courses/payment-states | |
QsrPosApi.DefaultApi | checksCheckNumberCoursesPost | POST /checks/{check_number}/courses | |
QsrPosApi.DefaultApi | checksCheckNumberDelete | DELETE /checks/{check_number} | |
QsrPosApi.DefaultApi | checksPost | POST /checks | |
QsrPosApi.DefaultApi | systemActivityLevelsCurrentActivityLevelGet | GET /system/activity-levels/current-activity-level | |
QsrPosApi.DefaultApi | systemActivityLevelsCurrentActivityLevelPut | PUT /system/activity-levels/current-activity-level | |
QsrPosApi.DefaultApi | systemActivityLevelsGet | GET /system/activity-levels | |
QsrPosApi.DefaultApi | systemEndOfDayPut | PUT /system/end-of-day | |
QsrPosApi.DefaultApi | systemPingGet | GET /system/ping | |
QsrPosApi.DefaultApi | systemRuntimeInformationGet | GET /system/runtime-information | |
QsrPosApi.DefaultApi | tableLocatorEventsPost | POST /table-locator-events | |
QsrPosApi.DefaultApi | tablesTableNameChecksCheckNumberCompletedCoursesPost | POST /tables/{table_name}/checks/{check_number}/completed-courses | |
QsrPosApi.DefaultApi | tablesTableNameChecksCheckNumberStatusPut | PUT /tables/{table_name}/checks/{check_number}/status | |
QsrPosApi.DefaultApi | tablesTableNameStatusPut | PUT /tables/{table_name}/status |
Documentation for Models
- QsrPosApi.ActivityLevel
- QsrPosApi.ActivityLevelList
- QsrPosApi.Check
- QsrPosApi.Course
- QsrPosApi.CoursePaymentState
- QsrPosApi.Item
- QsrPosApi.ItemCancellation
- QsrPosApi.ItemList
- QsrPosApi.ItemModifiers
- QsrPosApi.RuntimeInformation
- QsrPosApi.Server
- QsrPosApi.TableCheckStatus
- QsrPosApi.TableLocatorEvent
- QsrPosApi.TableStatus
Documentation for Authorization
All endpoints do not require authorization.
7 years ago