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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- MantleLib.AuthenticationApi | authenticationForgotpasswordConfirmationPost | POST /authentication/forgotpassword/confirmation | Forgot password code confirmation MantleLib.AuthenticationApi | authenticationForgotpasswordPost | POST /authentication/forgotpassword | Forgot password MantleLib.AuthenticationApi | authenticationLoginPost | POST /authentication/login | Login MantleLib.AuthenticationApi | authenticationLogoutPost | POST /authentication/logout | Logout MantleLib.AuthenticationApi | authenticationSignupConfirmationPost | POST /authentication/signup/confirmation | Sign up code confirmation MantleLib.AuthenticationApi | authenticationSignupPost | POST /authentication/signup | Sign up a user with an invitation MantleLib.BillingApi | billsGet | GET /bills | Get all bills MantleLib.InvitationsApi | invitationsByInvitationIdDelete | DELETE /invitations/{invitationId} | Deletes an invitation by invitationId MantleLib.InvitationsApi | invitationsByInvitationIdGet | GET /invitations/{invitationId} | Get an invitation by invitationId MantleLib.InvitationsApi | invitationsGet | GET /invitations | Get all invitations MantleLib.InvitationsApi | invitationsPost | POST /invitations | Creates an invitation MantleLib.KeeperApi | keeperFilesByFileIdDelete | DELETE /keeper/files/{fileId} | [FILES] Deletes a file by fileId MantleLib.KeeperApi | keeperFilesByFileIdGet | GET /keeper/files/{fileId} | [FILES] Get file by fileId MantleLib.KeeperApi | keeperFilesDiffLatestPost | POST /keeper/files/diff/latest | [FILES] Compares with latest version MantleLib.KeeperApi | keeperFilesDiffPost | POST /keeper/files/diff | [FILES] Compares a new file with the original file MantleLib.KeeperApi | keeperFilesExistPost | POST /keeper/files/exist | [FILES] Check if a file already exists MantleLib.KeeperApi | keeperFilesGet | GET /keeper/files | [FILES] Get all files MantleLib.KeeperApi | keeperFilesPost | POST /keeper/files | [FILES] Creates a file MantleLib.KeeperApi | keeperFoldersByFolderIdDelete | DELETE /keeper/folders/{folderId} | [FOLDERS] Delete a folder by folderId MantleLib.KeeperApi | keeperFoldersByFolderIdGet | GET /keeper/folders/{folderId} | [FOLDERS] Get a folder by folderId MantleLib.KeeperApi | keeperFoldersGet | GET /keeper/folders | [FOLDERS] Get all folders MantleLib.KeeperApi | keeperFoldersPost | POST /keeper/folders | [FOLDERS] Create a folder MantleLib.KeeperApi | keeperVersionsDiffPost | POST /keeper/versions/diff | [VERSIONS] Compares a new file with a specific version MantleLib.KeeperApi | keeperVersionsGet | GET /keeper/versions | [VERSIONS] Get all versions by fileId MantleLib.KeeperApi | keeperVersionsPost | POST /keeper/versions | [VERSIONS] Creates a version MantleLib.TrackerApi | trackerAssetsBatchesByAssetIdGet | GET /tracker/assets/batches/{assetId} | [ASSETS] Get all issue batch for an asset by id MantleLib.TrackerApi | trackerAssetsByAssetIdDelete | DELETE /tracker/assets/{assetId} | [ASSETS] Deletes an asset MantleLib.TrackerApi | trackerAssetsByAssetIdGet | GET /tracker/assets/{assetId} | [ASSETS] Get an asset by id MantleLib.TrackerApi | trackerAssetsByAssetIdPut | PUT /tracker/assets/{assetId} | [ASSETS] Updates an asset MantleLib.TrackerApi | trackerAssetsGet | GET /tracker/assets | [ASSETS] Get all assets MantleLib.TrackerApi | trackerAssetsIssuePost | POST /tracker/assets/issue | [ASSETS] Issues new assets for a specific user MantleLib.TrackerApi | trackerAssetsPost | POST /tracker/assets | [ASSETS] Creates an asset MantleLib.TrackerApi | trackerStatsGet | GET /tracker/stats | [STATS] Get network stats MantleLib.TrackerApi | trackerTransactionsGet | GET /tracker/transactions | [TRANSACTIONS] Get all transactions MantleLib.TrackerApi | trackerTransactionsReversePost | POST /tracker/transactions/reverse | [TRANSACTIONS] Reverts a transaction MantleLib.TrackerApi | trackerTransactionsSelfGet | GET /tracker/transactions/self | [TRANSACTIONS] Get all transactions of authenticated user MantleLib.TrackerApi | trackerWalletBalancesByAssetIdGet | GET /tracker/wallet/balances/{assetId} | [WALLET] Get all asset balances MantleLib.TrackerApi | trackerWalletBalancesGet | GET /tracker/wallet/balances | [WALLET] Get all account balances MantleLib.TrackerApi | trackerWalletBatchesTransferPost | POST /tracker/wallet/batches/transfer | [WALLET] Creates a batch transfer MantleLib.TrackerApi | trackerWalletTransactionsByAssetIdGet | GET /tracker/wallet/transactions/{assetId} | [WALLET] Get all transactions by assetId MantleLib.TrackerApi | trackerWalletTransferPost | POST /tracker/wallet/transfer | [WALLET] Creates a transfer MantleLib.UsersApi | usersByUserIdGet | GET /users/{userId} | Get a user by userId MantleLib.UsersApi | usersByUserIdPut | PUT /users/{userId} | Updates a user by userId MantleLib.UsersApi | usersDisableByUserIdPut | PUT /users/disable/{userId} | Disables a user by userId MantleLib.UsersApi | usersEnableByUserIdPut | PUT /users/enable/{userId} | Enables a user by userId MantleLib.UsersApi | usersGet | GET /users | Get all users MantleLib.UsersApi | usersSelfRolesGet | GET /users/self/roles | Get all roles of authenticated user

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.