This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

bookinghint-js-client

booking_hint

BookingHint - JavaScript client for booking_hint This is the API specification for the bookingHint project. Built on my propertyobject.js project, I have aimed to create a generic framework that can be easily adapted to as many applications as possible. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.1
• Package version: 0.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 booking_hint --save

git

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

    npm install YOUR_USERNAME/booking_hint --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 BookingHint = require('booking_hint');

var api = new BookingHint.AuthApi()

var username = "username_example"; // {String} The username that we want to login with. 

var body = new BookingHint.Body(); // {Body} Set the property \"password\" to the password to login with. 


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

Documentation for API Endpoints

All URIs are relative to http://localhost:8081

Class	Method	HTTP request	Description
BookingHint.AuthApi	loginPOST	POST /login
BookingHint.AuthApi	logoutDELETE	DELETE /logout
BookingHint.MessageApi	messagesGET	GET /messages
BookingHint.MessageApi	messagesGenericMessageidGET	GET /messages/generic/{messageid}
BookingHint.MessageApi	messagesGenericMessageidPropertykeyPUT	PUT /messages/generic/{messageid}/{propertykey}
BookingHint.MessageApi	messagesSmsPOST	POST /messages/sms
BookingHint.UserApi	usersGET	GET /users
BookingHint.UserApi	usersUsernameAdminGET	GET /users/{username}/admin
BookingHint.UserApi	usersUsernameAdminPUT	PUT /users/{username}/admin
BookingHint.UserApi	usersUsernameDELETE	DELETE /users/{username}
BookingHint.UserApi	usersUsernamePOST	POST /users/{username}
BookingHint.UserApi	usersUsernamePasswordPUT	PUT /users/{username}/password
BookingHint.UserApi	usersUsernameSettingsDELETE	DELETE /users/{username}/settings
BookingHint.UserApi	usersUsernameSettingsGET	GET /users/{username}/settings
BookingHint.UserApi	usersUsernameSettingsSettingkeyGET	GET /users/{username}/settings/{settingkey}
BookingHint.UserApi	usersUsernameSettingsSettingkeyPUT	PUT /users/{username}/settings/{settingkey}

Documentation for Models

• BookingHint.AuthKey
• BookingHint.Body
• BookingHint.Body1
• BookingHint.Body2
• BookingHint.Body3
• BookingHint.Body4
• BookingHint.Message
• BookingHint.Messages
• BookingHint.PropertyLogItem
• BookingHint.PropertyObject
• BookingHint.PropertyObjects
• BookingHint.UserIsAdmin
• BookingHint.Usernames

Documentation for Authorization

authKey

• Type: API key
• API key parameter name: authKey
• Location: URL query string