# techubank-api-client > This_API_allows_to_interact_with_the_amazing_TechUBank Latest version **2.0.10** (published 2018-10-11) · Apache 2.0 license · 0 weekly downloads ## Install ```sh npm install techubank-api-client pnpm add techubank-api-client yarn add techubank-api-client bun add techubank-api-client ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.10 | | Published | 2018-10-11 | | First published | 2018-10-10 | | Weekly downloads | 0 | | License | Apache 2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 277.6 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Maintainers | davidrova | ## Links - npm: https://www.npmjs.com/package/techubank-api-client - npm.io page: https://npm.io/package/techubank-api-client ## Dependencies (1) - [superagent](https://npm.io/package/superagent.md) 3.5.2 ## Recent versions - 2.0.10 (latest) — 2018-10-11 - 2.0.3 — 2018-10-10 - 2.0.2 — 2018-10-10 - 2.0.1 — 2018-10-10 - 2.0.0 — 2018-10-10 - 1.0.0 — 2018-10-10 ## README # techubank_api_client TechubankApiClient - JavaScript client for techubank_api_client This API allows to interact with the amazing TechUBank This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 2.0.0 - Package version: 2.0.0 - Build package: io.swagger.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 techubank_api_client --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 techubank_api_client from, and run: ```shell npm link /path/to/ ``` You should now be able to `require('techubank_api_client')` 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 TechubankApiClient = require('techubank_api_client'); var defaultClient = TechubankApiClient.ApiClient.instance; // Configure API key authorization: APIKeyHeader var APIKeyHeader = defaultClient.authentications['APIKeyHeader']; APIKeyHeader.apiKey = "YOUR API KEY" // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //APIKeyHeader.apiKeyPrefix['X-API-Key'] = "Token" var api = new TechubankApiClient.ProductsApi() var username = "username_example"; // {String} var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.getUserProducts(username, callback); ``` ## Documentation for API Endpoints All URIs are relative to *http://localhost:3000/v2* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *TechubankApiClient.ProductsApi* | [**getUserProducts**](docs/ProductsApi.md#getUserProducts) | **GET** /products/{username} | Get user products *TechubankApiClient.ProductsAccountApi* | [**createAccountProduct**](docs/ProductsAccountApi.md#createAccountProduct) | **POST** /products/{username}/account | Create user's product of type account *TechubankApiClient.ProductsAccountApi* | [**deleteAccount**](docs/ProductsAccountApi.md#deleteAccount) | **DELETE** /products/{username}/account/{accountId} | Delete user's account *TechubankApiClient.ProductsAccountApi* | [**getAccountDetail**](docs/ProductsAccountApi.md#getAccountDetail) | **GET** /products/{username}/account/{accountId} | Get user's account info *TechubankApiClient.ProductsAccountApi* | [**getAllUserAccounts**](docs/ProductsAccountApi.md#getAllUserAccounts) | **GET** /products/{username}/account | Get all user's products of type account *TechubankApiClient.ProductsAccountApi* | [**updateAccountInfo**](docs/ProductsAccountApi.md#updateAccountInfo) | **PUT** /products/{username}/account/{accountId} | Update user's account info *TechubankApiClient.ProductsAccountMovementsApi* | [**getAccountMovementDetail**](docs/ProductsAccountMovementsApi.md#getAccountMovementDetail) | **GET** /products/{username}/account/{accountId}/movements/{movementId} | Get detail user's movement info *TechubankApiClient.ProductsAccountMovementsApi* | [**getAccountMovements**](docs/ProductsAccountMovementsApi.md#getAccountMovements) | **GET** /products/{username}/account/{accountId}/movements | Get user's account movements *TechubankApiClient.ProductsAccountMovementsApi* | [**rejectAccountMovement**](docs/ProductsAccountMovementsApi.md#rejectAccountMovement) | **DELETE** /products/{username}/account/{accountId}/movements/{movementId} | Reject a movement *TechubankApiClient.ProductsAccountTransferApi* | [**getAllTransfers**](docs/ProductsAccountTransferApi.md#getAllTransfers) | **GET** /products/{username}/account/{accountId}/transfer | Get last transfers *TechubankApiClient.ProductsAccountTransferApi* | [**getTransferDetail**](docs/ProductsAccountTransferApi.md#getTransferDetail) | **GET** /products/{username}/account/{accountId}/transfer/{transferId} | Get detail info for a specific transfer *TechubankApiClient.ProductsAccountTransferApi* | [**makeTransfer**](docs/ProductsAccountTransferApi.md#makeTransfer) | **POST** /products/{username}/account/{accountId}/transfer | Create a transfer between two accounts *TechubankApiClient.ProductsAccountTransferApi* | [**rejectTransfer**](docs/ProductsAccountTransferApi.md#rejectTransfer) | **DELETE** /products/{username}/account/{accountId}/transfer/{transferId} | Reject a transfer *TechubankApiClient.UserApi* | [**changePassword**](docs/UserApi.md#changePassword) | **POST** /user/{username}/changePassword | Change user's password *TechubankApiClient.UserApi* | [**createUser**](docs/UserApi.md#createUser) | **POST** /user | Create a new user *TechubankApiClient.UserApi* | [**deleteUser**](docs/UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user *TechubankApiClient.UserApi* | [**getAllUsers**](docs/UserApi.md#getAllUsers) | **GET** /user | Get all users *TechubankApiClient.UserApi* | [**getGlobalPosition**](docs/UserApi.md#getGlobalPosition) | **GET** /user/{username}/globalposition | Get user's global position *TechubankApiClient.UserApi* | [**getUserByName**](docs/UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name *TechubankApiClient.UserApi* | [**loginUser**](docs/UserApi.md#loginUser) | **POST** /user/{username}/login | Logs user into the system *TechubankApiClient.UserApi* | [**logoutUser**](docs/UserApi.md#logoutUser) | **POST** /user/{username}/logout | Logout user *TechubankApiClient.UserApi* | [**updateUser**](docs/UserApi.md#updateUser) | **PUT** /user/{username} | Updated user ## Documentation for Models - [TechubankApiClient.Account](docs/Account.md) - [TechubankApiClient.ArrayOfMovements](docs/ArrayOfMovements.md) - [TechubankApiClient.ArrayOfTransfers](docs/ArrayOfTransfers.md) - [TechubankApiClient.ArrayOfUserAccounts](docs/ArrayOfUserAccounts.md) - [TechubankApiClient.ArrayOfUserProducts](docs/ArrayOfUserProducts.md) - [TechubankApiClient.ArrayOfUsers](docs/ArrayOfUsers.md) - [TechubankApiClient.Card](docs/Card.md) - [TechubankApiClient.ErrorMessage](docs/ErrorMessage.md) - [TechubankApiClient.Movement](docs/Movement.md) - [TechubankApiClient.TransferDetail](docs/TransferDetail.md) - [TechubankApiClient.TransferRequest](docs/TransferRequest.md) - [TechubankApiClient.User](docs/User.md) - [TechubankApiClient.UserBasicInfo](docs/UserBasicInfo.md) - [TechubankApiClient.UserGlobalPosition](docs/UserGlobalPosition.md) - [TechubankApiClient.UserLogin](docs/UserLogin.md) - [TechubankApiClient.UserLogout](docs/UserLogout.md) - [TechubankApiClient.UserProduct](docs/UserProduct.md) - [TechubankApiClient.UserResetPassword](docs/UserResetPassword.md) ## Documentation for Authorization ### APIKeyHeader - **Type**: API key - **API key parameter name**: X-API-Key - **Location**: HTTP header --- _Source: https://npm.io/package/techubank-api-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._