mantle-lib v1.0.5

mantle-lib

MantleLib - JavaScript client for mantle-lib Most endpoints requires authentication. You must first authenticate with your account using the endpoint: 'authentication/login' which will return an authorization token. You must then use this token in all your requests with the following header: Authorization: {ACCESS_TOKEN} . This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 1.0.5
• Build package: 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 mantle-lib --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 mantle-lib from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

    npm install YOUR_USERNAME/mantle-lib --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 MantleLib = require('mantle-lib');

var api = new MantleLib.AuthenticationApi()

var opts = { 
  'request': new MantleLib.UserForgotPasswordConfirmationRequest() // {UserForgotPasswordConfirmationRequest} 
};
api.authenticationForgotpasswordConfirmationPost(opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.mantle.services

Documentation for Models

• MantleLib.Bill
• MantleLib.IFormFile
• MantleLib.Invitation
• MantleLib.InvitationCreateRequest
• MantleLib.KeeperDiffHypervisorResponse
• MantleLib.KeeperFile
• MantleLib.KeeperFileVersion
• MantleLib.KeeperFolder
• MantleLib.KeeperFolderCreateRequest
• MantleLib.ProductUser
• MantleLib.TrackerAsset
• MantleLib.TrackerAssetBalance
• MantleLib.TrackerAssetCreateRequest
• MantleLib.TrackerAssetIssueRequest
• MantleLib.TrackerBalanceInfosHypervisorResponse
• MantleLib.TrackerBalancesHypervisorResponse
• MantleLib.TrackerBatchInfosHypervisorResponse
• MantleLib.TrackerBatchTransferRequest
• MantleLib.TrackerStatsResponse
• MantleLib.TrackerTransaction
• MantleLib.TrackerTransactionRevertRequest
• MantleLib.TrackerTransferRequest
• MantleLib.UserForgotPasswordConfirmationRequest
• MantleLib.UserForgotPasswordRequest
• MantleLib.UserLoginRequest
• MantleLib.UserLoginResponse
• MantleLib.UserSignUpConfirmationRequest
• MantleLib.UserSignUpRequest
• MantleLib.UserUpdateRequest

Documentation for Authorization

All endpoints do not require authorization.