npm.io
0.3.11 • Published 5 years ago

tinapi_

Licence
Unlicense
Version
0.3.11
Deps
1
Size
712 kB
Vulns
0
Weekly
0
DeprecatedThis package is deprecated
SummaryDependencyVersions

tinapi_minka

TinapiMinka - JavaScript client for tinapi_minka No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.2.21
  • Package version: 0.2.21
  • 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 tinapi_minka --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 tinapi_minka from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('tinapi_minka') 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 TinapiMinka = require('tinapi_minka');

var defaultClient = TinapiMinka.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['x-api-key'] = "Token"

// Configure API key authorization: XNonce
var XNonce = defaultClient.authentications['XNonce'];
XNonce.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//XNonce.apiKeyPrefix['x-nonce'] = "Token"

// Configure OAuth2 access token for authorization: oAuth2ClientCredentials
var oAuth2ClientCredentials = defaultClient.authentications['oAuth2ClientCredentials'];
oAuth2ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new TinapiMinka.ActionApi()
var createActionRequest = new TinapiMinka.CreateActionRequest(); // {CreateActionRequest} 
api.createAction(createActionRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://achtin-tst.minka.io/v1

Class Method HTTP request Description
TinapiMinka.ActionApi createAction POST /action Create an action
TinapiMinka.ActionApi getActionByActionId GET /action/{action_id} Get an action by action_id
TinapiMinka.ActionApi getActions GET /action Get Actions received
TinapiMinka.ActionApi getPending GET /action/unsigned Get unsigned actions
TinapiMinka.ActionApi signAction POST /action/{actionid}/signed Sign action
TinapiMinka.ActionApi signOffline POST /action/{actionid}/sendit Sign offline
TinapiMinka.ActionApi updateActionLabels PUT /action/{action_id} Update labels of an action
TinapiMinka.ConciliationApi getConciliation GET /conciliation Generates a conciliation txt file
TinapiMinka.DefaultApi updateActionLabels PUT /custom/action/{action_id} Update labels of an action
TinapiMinka.DefaultApi updateSignerCustom PUT /custom/signer/{signerAddress} Actualiza un signer
TinapiMinka.KeeperApi obtenerKeeper GET /keeper Genera un keeper
TinapiMinka.LinksApi createLink POST /link Create a link
TinapiMinka.LinksApi deleteLink DELETE /link/{link_id} Delete a link
TinapiMinka.LinksApi getLink GET /link Get a link
TinapiMinka.SignerApi callAction POST /signer/{userAddress}/router/{actionId}/action Call action in user's Bank
TinapiMinka.SignerApi callDownload POST /signer/{solicitanteAddress}/router/{actionId}/download Call credit in user's bank
TinapiMinka.SignerApi callStatus POST /signer/{solicitanteAddress}/router/{actionId}/status Notify status
TinapiMinka.SignerApi callUpload POST /signer/{userAddress}/router/{actionId}/upload Call debit in user's bank
TinapiMinka.SignerApi createSigner POST /signer Crea un signer
TinapiMinka.SignerApi deleteSignerByAddress DELETE /signer/{signerAddress} Delete signer
TinapiMinka.SignerApi getSignerByAddress GET /signer/{signerAddress} Obtiene un signer por address
TinapiMinka.SignerApi getSigners GET /signer Obtiene un signer
TinapiMinka.SignerApi updateSigner PUT /signer/{signerAddress} Actualiza un signer
TinapiMinka.TokenApi getToken POST /oauth/token Retrieve token
TinapiMinka.TransferApi acceptP2Ptranfer POST /transfer/{actionid}/accept Reject a P2p transfer
TinapiMinka.TransferApi continueP2Ptranfer POST /transfer/{actionid}/continue Continue async a P2p transfer
TinapiMinka.TransferApi createTinTransfer POST /transfer Create a P2P transfer
TinapiMinka.TransferApi getTransfers GET /transfer Get Transfers
TinapiMinka.TransferApi getTransfersAnalytics GET /transfer/analytics Get data related to Transfers
TinapiMinka.TransferApi rejectP2Ptranfer POST /transfer/{actionid}/reject Reject a P2P transfer
TinapiMinka.WalletApi createWallet POST /wallet Create a wallet
TinapiMinka.WalletApi getBalance GET /wallet/{handle}/balance Get default account balance of a wallet
TinapiMinka.WalletApi getWalletByAlias GET /wallet/{handle} Get a wallet
TinapiMinka.WalletApi getWalletBySigner GET /wallet Obtiene un wallet por signer
TinapiMinka.WalletApi sendSms POST /wallet/{solicitadoAlias}/channel/sms Send sms
TinapiMinka.WalletApi updateWallet PUT /wallet/{handle} Edit a wallet

Documentation for Models

Documentation for Authorization

ApiKeyAuth
  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header
BasicAuth
  • Type: HTTP basic authentication
XNonce
  • Type: API key
  • API key parameter name: x-nonce
  • Location: HTTP header
oAuth2ClientCredentials
  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A