1.0.11 • Published 4 years ago

investment_app_api v1.0.11

Weekly downloads
1
License
Unlicense
Repository
-
Last release
4 years ago

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 --save

Finally, you need to build the module:

npm run build
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

To 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 build

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):

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 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

ClassMethodHTTP requestDescription
InvestmentAppApi.CostIncreaseControllerApiaddANewCostIncreasePOST /cost-increasespost
InvestmentAppApi.CostIncreaseControllerApideleteCostIncreaseByIdDELETE /cost-increases/{projectId}delete
InvestmentAppApi.CostIncreaseControllerApigetAllCostIncreasesGET /cost-increasesget
InvestmentAppApi.CostIncreaseControllerApigetCostIncreaseByIdGET /cost-increases/{projectId}getById
InvestmentAppApi.CostIncreaseControllerApiupdateANewCostIncreasePUT /cost-increasesupdate
InvestmentAppApi.GeometryInfoControllerApigetGeometryInfosOfInvestmentGET /investments/{projectId}/geometry_infosget
InvestmentAppApi.InvestmentControllerApigetInvestmentByIdGET /investments/{projectId}get
InvestmentAppApi.InvestmentControllerApigetInvestmentsGET /investmentsget
InvestmentAppApi.NewProjectControllerApideleteNewProjectDELETE /new-projects/{id}deleteNewProject
InvestmentAppApi.NewProjectControllerApigetNewProjectsByFilterGET /new-projectsgetNewProjects
InvestmentAppApi.NewProjectControllerApisaveNewProjectPOST /new-projectssaveNewProject
InvestmentAppApi.NewProjectControllerApiupdateNewProjectPUT /new-projectsupdateNewProject
InvestmentAppApi.ReportControllerApigetBookletByRegionInvestmentUsingGETGET /reports/booklet-investment-provincegetBookletByRegionInvestment
InvestmentAppApi.ReportControllerApigetBookletGlobalUsingGETGET /reports/booklet-globalgetBookletGlobal
InvestmentAppApi.ReportControllerApigetBookletInvestmentAllUsingGETGET /reports/booklet-investment-allgetBookletInvestmentAll
InvestmentAppApi.ReportControllerApigetBookletStudyProgramUsingGETGET /reports/booklet-study-program-regiongetBookletStudyProgram
InvestmentAppApi.ReportControllerApigetNewProjectsReportGET /reports/new-projectsgetNewProjectsReport
InvestmentAppApi.ReportControllerApigetProjectStockReportUsingGETGET /reports/project-stockgetProjectStockReport
InvestmentAppApi.TransactionControllerApigetTransactionsByProjectIdGET /transactions/{projectId}get

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.