investment_app_api v1.0.11
investment_app_api
InvestmentAppApi - JavaScript client for investment_app_api 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: 1.0.11
- Package version: 1.0.11
- 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 investment_app_api --saveFinally, you need to build the module:
npm run buildLocal 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 installNext, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:
npm linkTo use the link you just defined in your project, switch to the directory you want to use your investment_app_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>Finally, you need to build the module:
npm run buildgit
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 --saveFor 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):
browserify main.js > bundle.jsThen 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 InvestmentAppApi = require('investment_app_api');
var api = new InvestmentAppApi.CostIncreaseControllerApi()
var costIncrease = new InvestmentAppApi.CostIncrease(); // {CostIncrease} costIncrease
api.addANewCostIncrease(costIncrease).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 http://localhost:28000/kgm/investment-app-v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| InvestmentAppApi.CostIncreaseControllerApi | addANewCostIncrease | POST /cost-increases | post |
| InvestmentAppApi.CostIncreaseControllerApi | deleteCostIncreaseById | DELETE /cost-increases/{projectId} | delete |
| InvestmentAppApi.CostIncreaseControllerApi | getAllCostIncreases | GET /cost-increases | get |
| InvestmentAppApi.CostIncreaseControllerApi | getCostIncreaseById | GET /cost-increases/{projectId} | getById |
| InvestmentAppApi.CostIncreaseControllerApi | updateANewCostIncrease | PUT /cost-increases | update |
| InvestmentAppApi.GeometryInfoControllerApi | getGeometryInfosOfInvestment | GET /investments/{projectId}/geometry_infos | get |
| InvestmentAppApi.InvestmentControllerApi | getInvestmentById | GET /investments/{projectId} | get |
| InvestmentAppApi.InvestmentControllerApi | getInvestments | GET /investments | get |
| InvestmentAppApi.NewProjectControllerApi | deleteNewProject | DELETE /new-projects/{id} | deleteNewProject |
| InvestmentAppApi.NewProjectControllerApi | getNewProjectsByFilter | GET /new-projects | getNewProjects |
| InvestmentAppApi.NewProjectControllerApi | saveNewProject | POST /new-projects | saveNewProject |
| InvestmentAppApi.NewProjectControllerApi | updateNewProject | PUT /new-projects | updateNewProject |
| InvestmentAppApi.ReportControllerApi | getBookletByRegionInvestmentUsingGET | GET /reports/booklet-investment-province | getBookletByRegionInvestment |
| InvestmentAppApi.ReportControllerApi | getBookletGlobalUsingGET | GET /reports/booklet-global | getBookletGlobal |
| InvestmentAppApi.ReportControllerApi | getBookletInvestmentAllUsingGET | GET /reports/booklet-investment-all | getBookletInvestmentAll |
| InvestmentAppApi.ReportControllerApi | getBookletStudyProgramUsingGET | GET /reports/booklet-study-program-region | getBookletStudyProgram |
| InvestmentAppApi.ReportControllerApi | getNewProjectsReport | GET /reports/new-projects | getNewProjectsReport |
| InvestmentAppApi.ReportControllerApi | getProjectStockReportUsingGET | GET /reports/project-stock | getProjectStockReport |
| InvestmentAppApi.TransactionControllerApi | getTransactionsByProjectId | GET /transactions/{projectId} | get |
Documentation for Models
- InvestmentAppApi.CostIncrease
- InvestmentAppApi.FeatureCollection
- InvestmentAppApi.Investment
- InvestmentAppApi.InvestmentId
- InvestmentAppApi.NewProject
Documentation for Authorization
All endpoints do not require authorization.
6 years ago