Meego-api NPM | npm.io

meego

Meego - JavaScript client for meego API documentation for Meego Backend. This SDK is automatically generated by the Swagger Codegen project:

API version: 0.0.1
Package version: 0.0.1
Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit www.mustansirzia.com

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 meego --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 meego from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('meego') 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/YOUR_USERNAME/meego then install it via:

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

var api = new Meego.GuideApi()

var opts = { 
  'emailPasswordModel': new Meego.EmailPasswordModel() // {EmailPasswordModel} 
};

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

Documentation for API Endpoints

All URIs are relative to https://localhost

Class	Method	HTTP request	Description
Meego.GuideApi	guideLoginPost	POST /guide/login	Tour guide logs in inside the app using this endpoint.
Meego.GuideApi	guideRegisterPost	POST /guide/register	Guide registers inside the app using this endpoint. This registration is subject to verification.
Meego.GuideApi	guideValidateEmailGet	GET /guide/validateEmail	This validates the email of the tour guide for uniqueness
Meego.UserApi	userLoginPost	POST /user/login	User logs in inside the app using this endpoint.
Meego.UserApi	userRegisterPost	POST /user/register	User registers inside the app using this endpoint.
Meego.UserApi	userRetryOtpGet	GET /user/retry-otp	Used for re sending OTP to the user for phone verification in case the earlier attempt fails.
Meego.UserApi	userSendOtpGet	GET /user/send-otp	Used for sending OTP to the user for phone verification. (On the condition that the phone number is unique)
Meego.UserApi	userSocialLoginPost	POST /user/social-login	Used for social login. Takes a OAuth token and a type. Response may not have all the user details depending on the login status.
Meego.UserApi	userValidateEmailGet	GET /user/validate-email	Validates uniqueness of a user's email.
Meego.UserApi	userVerifyOtpGet	GET /user/verify-otp	Used for veryfing OTP sent by the user.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

superagent

@everything-registry/sub-chunk-2151 @infinitebrahmanuniverse/nolb-mee

0.0.1

7 years ago