makurosu_api

MakurosuApi - JavaScript client for makurosu_api This is Makurosu API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.0.1
• Package version: 0.0.1
• Build package: org.openapitools.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 makurosu_api --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 makurosu_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('makurosu_api') 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/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, 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 MakurosuApi = require('makurosu_api');

var api = new MakurosuApi.SessionsApi()
var opts = {
  'inlineObject2': new MakurosuApi.InlineObject2() // {InlineObject2} 
};

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

Documentation for API Endpoints

All URIs are relative to http://172.17.3.71:3000

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MakurosuApi.SessionsApi | createSessions | POST /makurosu/api/v1/console/sessions/sign_in | sign in MakurosuApi.SessionsApi | deleteSession | DELETE /makurosu/api/v1/console/sessions/sign_in | sign out MakurosuApi.SessionsApi | makurosuApiV1ConsoleSessionsCodeVerificationPost | POST /makurosu/api/v1/console/sessions/code_verification | code_verification MakurosuApi.SessionsApi | makurosuApiV1ConsoleSessionsEmailCodeGet | GET /makurosu/api/v1/console/sessions/email_code | email_code MakurosuApi.SessionsApi | otpVerification | POST /makurosu/api/v1/console/sessions/otp_verification | otp verification MakurosuApi.SessionsApi | signUp | POST /makurosu/api/v1/console/sessions/sign_up | sign up

Documentation for Models

• MakurosuApi.Error
• MakurosuApi.InlineObject
• MakurosuApi.InlineObject1
• MakurosuApi.InlineObject2
• MakurosuApi.InlineObject3
• MakurosuApi.InlineResponse200
• MakurosuApi.InlineResponse201
• MakurosuApi.InlineResponse2011
• MakurosuApi.InlineResponse201Data
• MakurosuApi.InlineResponse204
• MakurosuApi.Session

Documentation for Authorization

All endpoints do not require authorization.