# makurosu_api

MakurosuApi - JavaScript client for makurosu_api
This is Makurosu API
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.0.1
- Package version: 0.0.1
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
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:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

Finally, switch to the directory you want to use your makurosu_api from, and run:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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**](docs/SessionsApi.md#createSessions) | **POST** /makurosu/api/v1/console/sessions/sign_in | sign in
*MakurosuApi.SessionsApi* | [**deleteSession**](docs/SessionsApi.md#deleteSession) | **DELETE** /makurosu/api/v1/console/sessions/sign_in | sign out
*MakurosuApi.SessionsApi* | [**makurosuApiV1ConsoleSessionsCodeVerificationPost**](docs/SessionsApi.md#makurosuApiV1ConsoleSessionsCodeVerificationPost) | **POST** /makurosu/api/v1/console/sessions/code_verification | code_verification
*MakurosuApi.SessionsApi* | [**makurosuApiV1ConsoleSessionsEmailCodeGet**](docs/SessionsApi.md#makurosuApiV1ConsoleSessionsEmailCodeGet) | **GET** /makurosu/api/v1/console/sessions/email_code | email_code
*MakurosuApi.SessionsApi* | [**otpVerification**](docs/SessionsApi.md#otpVerification) | **POST** /makurosu/api/v1/console/sessions/otp_verification | otp verification
*MakurosuApi.SessionsApi* | [**signUp**](docs/SessionsApi.md#signUp) | **POST** /makurosu/api/v1/console/sessions/sign_up | sign up


## Documentation for Models

 - [MakurosuApi.Error](docs/Error.md)
 - [MakurosuApi.InlineObject](docs/InlineObject.md)
 - [MakurosuApi.InlineObject1](docs/InlineObject1.md)
 - [MakurosuApi.InlineObject2](docs/InlineObject2.md)
 - [MakurosuApi.InlineObject3](docs/InlineObject3.md)
 - [MakurosuApi.InlineResponse200](docs/InlineResponse200.md)
 - [MakurosuApi.InlineResponse201](docs/InlineResponse201.md)
 - [MakurosuApi.InlineResponse2011](docs/InlineResponse2011.md)
 - [MakurosuApi.InlineResponse201Data](docs/InlineResponse201Data.md)
 - [MakurosuApi.InlineResponse204](docs/InlineResponse204.md)
 - [MakurosuApi.Session](docs/Session.md)


## Documentation for Authorization

 All endpoints do not require authorization.

