techubank-api-client v2.0.10
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 project:
- API version: 2.0.0
- Package version: 2.0.0
- 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 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:
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 techubank_api_client from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
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:
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 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 | GET /products/{username} | Get user products |
TechubankApiClient.ProductsAccountApi | createAccountProduct | POST /products/{username}/account | Create user's product of type account |
TechubankApiClient.ProductsAccountApi | deleteAccount | DELETE /products/{username}/account/{accountId} | Delete user's account |
TechubankApiClient.ProductsAccountApi | getAccountDetail | GET /products/{username}/account/{accountId} | Get user's account info |
TechubankApiClient.ProductsAccountApi | getAllUserAccounts | GET /products/{username}/account | Get all user's products of type account |
TechubankApiClient.ProductsAccountApi | updateAccountInfo | PUT /products/{username}/account/{accountId} | Update user's account info |
TechubankApiClient.ProductsAccountMovementsApi | getAccountMovementDetail | GET /products/{username}/account/{accountId}/movements/{movementId} | Get detail user's movement info |
TechubankApiClient.ProductsAccountMovementsApi | getAccountMovements | GET /products/{username}/account/{accountId}/movements | Get user's account movements |
TechubankApiClient.ProductsAccountMovementsApi | rejectAccountMovement | DELETE /products/{username}/account/{accountId}/movements/{movementId} | Reject a movement |
TechubankApiClient.ProductsAccountTransferApi | getAllTransfers | GET /products/{username}/account/{accountId}/transfer | Get last transfers |
TechubankApiClient.ProductsAccountTransferApi | getTransferDetail | GET /products/{username}/account/{accountId}/transfer/{transferId} | Get detail info for a specific transfer |
TechubankApiClient.ProductsAccountTransferApi | makeTransfer | POST /products/{username}/account/{accountId}/transfer | Create a transfer between two accounts |
TechubankApiClient.ProductsAccountTransferApi | rejectTransfer | DELETE /products/{username}/account/{accountId}/transfer/{transferId} | Reject a transfer |
TechubankApiClient.UserApi | changePassword | POST /user/{username}/changePassword | Change user's password |
TechubankApiClient.UserApi | createUser | POST /user | Create a new user |
TechubankApiClient.UserApi | deleteUser | DELETE /user/{username} | Delete user |
TechubankApiClient.UserApi | getAllUsers | GET /user | Get all users |
TechubankApiClient.UserApi | getGlobalPosition | GET /user/{username}/globalposition | Get user's global position |
TechubankApiClient.UserApi | getUserByName | GET /user/{username} | Get user by user name |
TechubankApiClient.UserApi | loginUser | POST /user/{username}/login | Logs user into the system |
TechubankApiClient.UserApi | logoutUser | POST /user/{username}/logout | Logout user |
TechubankApiClient.UserApi | updateUser | PUT /user/{username} | Updated user |
Documentation for Models
- TechubankApiClient.Account
- TechubankApiClient.ArrayOfMovements
- TechubankApiClient.ArrayOfTransfers
- TechubankApiClient.ArrayOfUserAccounts
- TechubankApiClient.ArrayOfUserProducts
- TechubankApiClient.ArrayOfUsers
- TechubankApiClient.Card
- TechubankApiClient.ErrorMessage
- TechubankApiClient.Movement
- TechubankApiClient.TransferDetail
- TechubankApiClient.TransferRequest
- TechubankApiClient.User
- TechubankApiClient.UserBasicInfo
- TechubankApiClient.UserGlobalPosition
- TechubankApiClient.UserLogin
- TechubankApiClient.UserLogout
- TechubankApiClient.UserProduct
- TechubankApiClient.UserResetPassword
Documentation for Authorization
APIKeyHeader
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header