# tinapi_ > Client for Minka cloud Latest version **0.3.11** (published 2020-12-21) · Unlicense license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install tinapi_ pnpm add tinapi_ yarn add tinapi_ bun add tinapi_ ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 0.3.11 | | Published | 2020-12-21 | | First published | 2018-08-25 | | Weekly downloads | 0 | | License | Unlicense | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 712.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | arkgast, jesusfchavarro, luisbar-minka | ## Links - npm: https://www.npmjs.com/package/tinapi_ - npm.io page: https://npm.io/package/tinapi_ ## Dependencies (1) - [superagent](https://npm.io/package/superagent.md) 4.1.0 ## Recent versions - 0.3.11 (latest) — 2020-12-21 - 0.3.10 — 2020-12-02 - 0.3.9 — 2020-06-18 - 0.3.8 — 2019-10-23 - 0.3.7 — 2019-10-22 - 0.3.6 — 2019-10-22 - 0.3.5 — 2019-07-10 - 0.3.4 — 2019-07-10 - 0.3.2 — 2019-04-03 - 0.3.1 — 2019-03-11 - 0.3.0 — 2019-03-11 - 0.2.22 — 2019-03-09 - 0.2.21 — 2018-11-22 - 0.2.20 — 2018-11-08 - 0.2.19 — 2018-11-08 - … 31 more at https://npm.io/package/tinapi_/versions ## README # 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](https://openapi-generator.tech) project: - API version: 0.2.21 - Package version: 0.2.21 - 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 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: ```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 tinapi_minka from, and run: ```shell npm link /path/to/ ``` 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: ```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 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**](docs/ActionApi.md#createAction) | **POST** /action | Create an action *TinapiMinka.ActionApi* | [**getActionByActionId**](docs/ActionApi.md#getActionByActionId) | **GET** /action/{action_id} | Get an action by action_id *TinapiMinka.ActionApi* | [**getActions**](docs/ActionApi.md#getActions) | **GET** /action | Get Actions received *TinapiMinka.ActionApi* | [**getPending**](docs/ActionApi.md#getPending) | **GET** /action/unsigned | Get unsigned actions *TinapiMinka.ActionApi* | [**signAction**](docs/ActionApi.md#signAction) | **POST** /action/{actionid}/signed | Sign action *TinapiMinka.ActionApi* | [**signOffline**](docs/ActionApi.md#signOffline) | **POST** /action/{actionid}/sendit | Sign offline *TinapiMinka.ActionApi* | [**updateActionLabels**](docs/ActionApi.md#updateActionLabels) | **PUT** /action/{action_id} | Update labels of an action *TinapiMinka.ConciliationApi* | [**getConciliation**](docs/ConciliationApi.md#getConciliation) | **GET** /conciliation | Generates a conciliation txt file *TinapiMinka.DefaultApi* | [**updateActionLabels**](docs/DefaultApi.md#updateActionLabels) | **PUT** /custom/action/{action_id} | Update labels of an action *TinapiMinka.DefaultApi* | [**updateSignerCustom**](docs/DefaultApi.md#updateSignerCustom) | **PUT** /custom/signer/{signerAddress} | Actualiza un signer *TinapiMinka.KeeperApi* | [**obtenerKeeper**](docs/KeeperApi.md#obtenerKeeper) | **GET** /keeper | Genera un keeper *TinapiMinka.LinksApi* | [**createLink**](docs/LinksApi.md#createLink) | **POST** /link | Create a link *TinapiMinka.LinksApi* | [**deleteLink**](docs/LinksApi.md#deleteLink) | **DELETE** /link/{link_id} | Delete a link *TinapiMinka.LinksApi* | [**getLink**](docs/LinksApi.md#getLink) | **GET** /link | Get a link *TinapiMinka.SignerApi* | [**callAction**](docs/SignerApi.md#callAction) | **POST** /signer/{userAddress}/router/{actionId}/action | Call action in user's Bank *TinapiMinka.SignerApi* | [**callDownload**](docs/SignerApi.md#callDownload) | **POST** /signer/{solicitanteAddress}/router/{actionId}/download | Call credit in user's bank *TinapiMinka.SignerApi* | [**callStatus**](docs/SignerApi.md#callStatus) | **POST** /signer/{solicitanteAddress}/router/{actionId}/status | Notify status *TinapiMinka.SignerApi* | [**callUpload**](docs/SignerApi.md#callUpload) | **POST** /signer/{userAddress}/router/{actionId}/upload | Call debit in user's bank *TinapiMinka.SignerApi* | [**createSigner**](docs/SignerApi.md#createSigner) | **POST** /signer | Crea un signer *TinapiMinka.SignerApi* | [**deleteSignerByAddress**](docs/SignerApi.md#deleteSignerByAddress) | **DELETE** /signer/{signerAddress} | Delete signer *TinapiMinka.SignerApi* | [**getSignerByAddress**](docs/SignerApi.md#getSignerByAddress) | **GET** /signer/{signerAddress} | Obtiene un signer por address *TinapiMinka.SignerApi* | [**getSigners**](docs/SignerApi.md#getSigners) | **GET** /signer | Obtiene un signer *TinapiMinka.SignerApi* | [**updateSigner**](docs/SignerApi.md#updateSigner) | **PUT** /signer/{signerAddress} | Actualiza un signer *TinapiMinka.TokenApi* | [**getToken**](docs/TokenApi.md#getToken) | **POST** /oauth/token | Retrieve token *TinapiMinka.TransferApi* | [**acceptP2Ptranfer**](docs/TransferApi.md#acceptP2Ptranfer) | **POST** /transfer/{actionid}/accept | Reject a P2p transfer *TinapiMinka.TransferApi* | [**continueP2Ptranfer**](docs/TransferApi.md#continueP2Ptranfer) | **POST** /transfer/{actionid}/continue | Continue async a P2p transfer *TinapiMinka.TransferApi* | [**createTinTransfer**](docs/TransferApi.md#createTinTransfer) | **POST** /transfer | Create a P2P transfer *TinapiMinka.TransferApi* | [**getTransfers**](docs/TransferApi.md#getTransfers) | **GET** /transfer | Get Transfers *TinapiMinka.TransferApi* | [**getTransfersAnalytics**](docs/TransferApi.md#getTransfersAnalytics) | **GET** /transfer/analytics | Get data related to Transfers *TinapiMinka.TransferApi* | [**rejectP2Ptranfer**](docs/TransferApi.md#rejectP2Ptranfer) | **POST** /transfer/{actionid}/reject | Reject a P2P transfer *TinapiMinka.WalletApi* | [**createWallet**](docs/WalletApi.md#createWallet) | **POST** /wallet | Create a wallet *TinapiMinka.WalletApi* | [**getBalance**](docs/WalletApi.md#getBalance) | **GET** /wallet/{handle}/balance | Get default account balance of a wallet *TinapiMinka.WalletApi* | [**getWalletByAlias**](docs/WalletApi.md#getWalletByAlias) | **GET** /wallet/{handle} | Get a wallet *TinapiMinka.WalletApi* | [**getWalletBySigner**](docs/WalletApi.md#getWalletBySigner) | **GET** /wallet | Obtiene un wallet por signer *TinapiMinka.WalletApi* | [**sendSms**](docs/WalletApi.md#sendSms) | **POST** /wallet/{solicitadoAlias}/channel/sms | Send sms *TinapiMinka.WalletApi* | [**updateWallet**](docs/WalletApi.md#updateWallet) | **PUT** /wallet/{handle} | Edit a wallet ## Documentation for Models - [TinapiMinka.AcceptTransferRequest](docs/AcceptTransferRequest.md) - [TinapiMinka.ActionSigned](docs/ActionSigned.md) - [TinapiMinka.ActionSignedLabels](docs/ActionSignedLabels.md) - [TinapiMinka.BalanceResponse](docs/BalanceResponse.md) - [TinapiMinka.BalanceResponseError](docs/BalanceResponseError.md) - [TinapiMinka.Claims](docs/Claims.md) - [TinapiMinka.Conciliation](docs/Conciliation.md) - [TinapiMinka.CreateActionRequest](docs/CreateActionRequest.md) - [TinapiMinka.CreateActionRequestLabels](docs/CreateActionRequestLabels.md) - [TinapiMinka.CreateActionResponse](docs/CreateActionResponse.md) - [TinapiMinka.CreateActionResponseLabels](docs/CreateActionResponseLabels.md) - [TinapiMinka.CreateActionStoreRequest](docs/CreateActionStoreRequest.md) - [TinapiMinka.CreateClaimRequest](docs/CreateClaimRequest.md) - [TinapiMinka.CreateClaimResponse](docs/CreateClaimResponse.md) - [TinapiMinka.CreateIouRequest](docs/CreateIouRequest.md) - [TinapiMinka.CreateLinkRequest](docs/CreateLinkRequest.md) - [TinapiMinka.CreateTransferRequest](docs/CreateTransferRequest.md) - [TinapiMinka.CreateTransferRequestLabels](docs/CreateTransferRequestLabels.md) - [TinapiMinka.CreateTransferResponse](docs/CreateTransferResponse.md) - [TinapiMinka.DeviceFingerPrint](docs/DeviceFingerPrint.md) - [TinapiMinka.DomainResponse](docs/DomainResponse.md) - [TinapiMinka.ErrorForbidden](docs/ErrorForbidden.md) - [TinapiMinka.ErrorGenerico](docs/ErrorGenerico.md) - [TinapiMinka.ErrorResponse](docs/ErrorResponse.md) - [TinapiMinka.GenericResponse](docs/GenericResponse.md) - [TinapiMinka.GetActionResponse](docs/GetActionResponse.md) - [TinapiMinka.GetAnalyticsResponse](docs/GetAnalyticsResponse.md) - [TinapiMinka.GetAnalyticsResponseEntities](docs/GetAnalyticsResponseEntities.md) - [TinapiMinka.GetLinkResponse](docs/GetLinkResponse.md) - [TinapiMinka.GetTransferResponse](docs/GetTransferResponse.md) - [TinapiMinka.GetTransfersResponse](docs/GetTransfersResponse.md) - [TinapiMinka.GetWalletResponse](docs/GetWalletResponse.md) - [TinapiMinka.IouSigned](docs/IouSigned.md) - [TinapiMinka.IouSignedData](docs/IouSignedData.md) - [TinapiMinka.IouSignedHash](docs/IouSignedHash.md) - [TinapiMinka.IouSignedMeta](docs/IouSignedMeta.md) - [TinapiMinka.Keeper](docs/Keeper.md) - [TinapiMinka.LinkItem](docs/LinkItem.md) - [TinapiMinka.Links](docs/Links.md) - [TinapiMinka.ListLinks](docs/ListLinks.md) - [TinapiMinka.OfflineSigningKeys](docs/OfflineSigningKeys.md) - [TinapiMinka.Pagination](docs/Pagination.md) - [TinapiMinka.PendingActionResponse](docs/PendingActionResponse.md) - [TinapiMinka.PublicKeys](docs/PublicKeys.md) - [TinapiMinka.RejectTransferRequest](docs/RejectTransferRequest.md) - [TinapiMinka.Signatures](docs/Signatures.md) - [TinapiMinka.SignerLabelsResponse](docs/SignerLabelsResponse.md) - [TinapiMinka.SignerListResponse](docs/SignerListResponse.md) - [TinapiMinka.SignerObject](docs/SignerObject.md) - [TinapiMinka.SignerRequest](docs/SignerRequest.md) - [TinapiMinka.SignerRequestLabels](docs/SignerRequestLabels.md) - [TinapiMinka.SignerResponse](docs/SignerResponse.md) - [TinapiMinka.SignerSnapshotResponse](docs/SignerSnapshotResponse.md) - [TinapiMinka.SmsRequest](docs/SmsRequest.md) - [TinapiMinka.Snapshot](docs/Snapshot.md) - [TinapiMinka.SnapshotSymbol](docs/SnapshotSymbol.md) - [TinapiMinka.SnapshotSymbolSigner](docs/SnapshotSymbolSigner.md) - [TinapiMinka.SnapshotSymbolWallet](docs/SnapshotSymbolWallet.md) - [TinapiMinka.SnapshotSymbolWalletLabels](docs/SnapshotSymbolWalletLabels.md) - [TinapiMinka.SnapshotTarget](docs/SnapshotTarget.md) - [TinapiMinka.TokenResponse](docs/TokenResponse.md) - [TinapiMinka.Transfers](docs/Transfers.md) - [TinapiMinka.UpdateActionRequest](docs/UpdateActionRequest.md) - [TinapiMinka.UpdateActionRequestLabels](docs/UpdateActionRequestLabels.md) - [TinapiMinka.WalletListResponse](docs/WalletListResponse.md) - [TinapiMinka.WalletObject](docs/WalletObject.md) - [TinapiMinka.WalletObjectLabels](docs/WalletObjectLabels.md) - [TinapiMinka.WalletRequest](docs/WalletRequest.md) - [TinapiMinka.WalletRequestLabels](docs/WalletRequestLabels.md) - [TinapiMinka.WalletResponse](docs/WalletResponse.md) - [TinapiMinka.WalletSnapshotResponse](docs/WalletSnapshotResponse.md) - [TinapiMinka.WalletUpdateRequest](docs/WalletUpdateRequest.md) - [TinapiMinka.WalletUpdateResponse](docs/WalletUpdateResponse.md) - [TinapiMinka.WalletsResponse](docs/WalletsResponse.md) ## 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 --- _Source: https://npm.io/package/tinapi_ · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._