@cosmotech/aip-client 0.2.0-dev2 → 0.2.0-dev3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +141 -4
- package/api/default-api.ts +8 -15
- package/api/impact-api.ts +507 -0
- package/api/investment-api.ts +1308 -0
- package/api/metric-api.ts +185 -164
- package/api/metric-costs-api.ts +144 -0
- package/api/metric-costs-per-year-api.ts +200 -200
- package/api/objective-api.ts +538 -44
- package/api/objective-weight-api.ts +190 -190
- package/api/objective-weights-api.ts +144 -0
- package/api/option-api.ts +925 -0
- package/api/value-framework-api.ts +1223 -109
- package/api/value-framework-costs-api.ts +239 -0
- package/api/value-framework-weights-api.ts +144 -0
- package/api.ts +8 -1
- package/base.ts +1 -25
- package/common.ts +20 -43
- package/configuration.ts +31 -20
- package/dist/api/default-api.d.ts +3 -10
- package/dist/api/default-api.js +7 -13
- package/dist/api/impact-api.d.ts +245 -0
- package/dist/api/impact-api.js +493 -0
- package/dist/api/investment-api.d.ts +607 -0
- package/dist/api/investment-api.js +1248 -0
- package/dist/api/metric-api.d.ts +97 -88
- package/dist/api/metric-api.js +185 -157
- package/dist/api/metric-costs-api.d.ts +75 -0
- package/dist/api/metric-costs-api.js +146 -0
- package/dist/api/metric-costs-per-year-api.d.ts +105 -108
- package/dist/api/metric-costs-per-year-api.js +199 -192
- package/dist/api/objective-api.d.ts +242 -21
- package/dist/api/objective-api.js +508 -37
- package/dist/api/objective-weight-api.d.ts +105 -108
- package/dist/api/objective-weight-api.js +189 -182
- package/dist/api/objective-weights-api.d.ts +75 -0
- package/dist/api/objective-weights-api.js +146 -0
- package/dist/api/option-api.d.ts +436 -0
- package/dist/api/option-api.js +888 -0
- package/dist/api/value-framework-api.d.ts +528 -21
- package/dist/api/value-framework-api.js +1138 -78
- package/dist/api/value-framework-costs-api.d.ts +119 -0
- package/dist/api/value-framework-costs-api.js +236 -0
- package/dist/api/value-framework-weights-api.d.ts +75 -0
- package/dist/api/value-framework-weights-api.js +146 -0
- package/dist/api.d.ts +8 -1
- package/dist/api.js +8 -1
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +6 -37
- package/dist/common.js +17 -39
- package/dist/configuration.d.ts +25 -18
- package/dist/configuration.js +4 -3
- package/dist/esm/api/default-api.d.ts +3 -10
- package/dist/esm/api/default-api.js +7 -13
- package/dist/esm/api/impact-api.d.ts +245 -0
- package/dist/esm/api/impact-api.js +486 -0
- package/dist/esm/api/investment-api.d.ts +607 -0
- package/dist/esm/api/investment-api.js +1241 -0
- package/dist/esm/api/metric-api.d.ts +97 -88
- package/dist/esm/api/metric-api.js +185 -157
- package/dist/esm/api/metric-costs-api.d.ts +75 -0
- package/dist/esm/api/metric-costs-api.js +139 -0
- package/dist/esm/api/metric-costs-per-year-api.d.ts +105 -108
- package/dist/esm/api/metric-costs-per-year-api.js +199 -192
- package/dist/esm/api/objective-api.d.ts +242 -21
- package/dist/esm/api/objective-api.js +508 -37
- package/dist/esm/api/objective-weight-api.d.ts +105 -108
- package/dist/esm/api/objective-weight-api.js +189 -182
- package/dist/esm/api/objective-weights-api.d.ts +75 -0
- package/dist/esm/api/objective-weights-api.js +139 -0
- package/dist/esm/api/option-api.d.ts +436 -0
- package/dist/esm/api/option-api.js +881 -0
- package/dist/esm/api/value-framework-api.d.ts +528 -21
- package/dist/esm/api/value-framework-api.js +1137 -77
- package/dist/esm/api/value-framework-costs-api.d.ts +119 -0
- package/dist/esm/api/value-framework-costs-api.js +229 -0
- package/dist/esm/api/value-framework-weights-api.d.ts +75 -0
- package/dist/esm/api/value-framework-weights-api.js +139 -0
- package/dist/esm/api.d.ts +8 -1
- package/dist/esm/api.js +8 -1
- package/dist/esm/base.d.ts +1 -25
- package/dist/esm/base.js +1 -20
- package/dist/esm/common.d.ts +6 -37
- package/dist/esm/common.js +15 -38
- package/dist/esm/configuration.d.ts +25 -18
- package/dist/esm/configuration.js +4 -3
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/evolution-type.d.ts +16 -0
- package/dist/esm/models/evolution-type.js +17 -0
- package/dist/esm/models/httpvalidation-error.d.ts +2 -12
- package/dist/esm/models/httpvalidation-error.js +1 -1
- package/dist/esm/models/impact-apiresponse.d.ts +33 -0
- package/dist/esm/models/{validation-error-loc-inner.js → impact-apiresponse.js} +1 -1
- package/dist/esm/models/impact-create.d.ts +37 -0
- package/dist/esm/models/impact-create.js +14 -0
- package/dist/esm/models/impact-update.d.ts +22 -0
- package/dist/esm/models/impact-update.js +14 -0
- package/dist/esm/models/index.d.ts +11 -1
- package/dist/esm/models/index.js +11 -1
- package/dist/esm/models/investment-create.d.ts +21 -0
- package/dist/esm/models/investment-create.js +14 -0
- package/dist/esm/models/investment-response.d.ts +25 -0
- package/dist/esm/models/investment-response.js +14 -0
- package/dist/esm/models/investment-update.d.ts +18 -0
- package/dist/esm/models/investment-update.js +14 -0
- package/dist/esm/models/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
- package/dist/esm/models/location-inner.js +14 -0
- package/dist/esm/models/measurement-type.d.ts +1 -6
- package/dist/esm/models/measurement-type.js +1 -6
- package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -17
- package/dist/esm/models/metric-costs-per-year-create.js +1 -1
- package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -18
- package/dist/esm/models/metric-costs-per-year-response.js +1 -1
- package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -13
- package/dist/esm/models/metric-costs-per-year-update.js +1 -1
- package/dist/esm/models/metric-create.d.ts +3 -28
- package/dist/esm/models/metric-create.js +1 -1
- package/dist/esm/models/metric-response.d.ts +3 -50
- package/dist/esm/models/metric-response.js +1 -1
- package/dist/esm/models/metric-type.d.ts +1 -6
- package/dist/esm/models/metric-type.js +1 -6
- package/dist/esm/models/metric-update.d.ts +3 -35
- package/dist/esm/models/metric-update.js +1 -1
- package/dist/esm/models/objective-create.d.ts +1 -10
- package/dist/esm/models/objective-create.js +1 -1
- package/dist/esm/models/objective-response.d.ts +1 -30
- package/dist/esm/models/objective-response.js +1 -1
- package/dist/esm/models/objective-update.d.ts +1 -13
- package/dist/esm/models/objective-update.js +1 -1
- package/dist/esm/models/objective-weight-create.d.ts +1 -9
- package/dist/esm/models/objective-weight-create.js +1 -1
- package/dist/esm/models/objective-weight-response.d.ts +1 -14
- package/dist/esm/models/objective-weight-response.js +1 -1
- package/dist/esm/models/objective-weight-update.d.ts +1 -8
- package/dist/esm/models/objective-weight-update.js +1 -1
- package/dist/esm/models/option-create.d.ts +33 -0
- package/dist/esm/models/option-create.js +14 -0
- package/dist/esm/models/option-response.d.ts +31 -0
- package/dist/esm/models/option-response.js +14 -0
- package/dist/esm/models/option-update.d.ts +19 -0
- package/dist/esm/models/option-update.js +14 -0
- package/dist/esm/models/validation-error.d.ts +3 -33
- package/dist/esm/models/validation-error.js +1 -1
- package/dist/esm/models/value-framework-create.d.ts +1 -10
- package/dist/esm/models/value-framework-create.js +1 -1
- package/dist/esm/models/value-framework-response.d.ts +1 -30
- package/dist/esm/models/value-framework-response.js +1 -1
- package/dist/esm/models/value-framework-update.d.ts +1 -13
- package/dist/esm/models/value-framework-update.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/evolution-type.d.ts +16 -0
- package/dist/models/evolution-type.js +20 -0
- package/dist/models/httpvalidation-error.d.ts +2 -12
- package/dist/models/httpvalidation-error.js +1 -1
- package/dist/models/impact-apiresponse.d.ts +33 -0
- package/dist/models/{validation-error-loc-inner.js → impact-apiresponse.js} +1 -1
- package/dist/models/impact-create.d.ts +37 -0
- package/dist/models/impact-create.js +15 -0
- package/dist/models/impact-update.d.ts +22 -0
- package/dist/models/impact-update.js +15 -0
- package/dist/models/index.d.ts +11 -1
- package/dist/models/index.js +11 -1
- package/dist/models/investment-create.d.ts +21 -0
- package/dist/models/investment-create.js +15 -0
- package/dist/models/investment-response.d.ts +25 -0
- package/dist/models/investment-response.js +15 -0
- package/dist/models/investment-update.d.ts +18 -0
- package/dist/models/investment-update.js +15 -0
- package/dist/models/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
- package/dist/models/location-inner.js +15 -0
- package/dist/models/measurement-type.d.ts +1 -6
- package/dist/models/measurement-type.js +1 -6
- package/dist/models/metric-costs-per-year-create.d.ts +1 -17
- package/dist/models/metric-costs-per-year-create.js +1 -1
- package/dist/models/metric-costs-per-year-response.d.ts +1 -18
- package/dist/models/metric-costs-per-year-response.js +1 -1
- package/dist/models/metric-costs-per-year-update.d.ts +1 -13
- package/dist/models/metric-costs-per-year-update.js +1 -1
- package/dist/models/metric-create.d.ts +3 -28
- package/dist/models/metric-create.js +1 -1
- package/dist/models/metric-response.d.ts +3 -50
- package/dist/models/metric-response.js +1 -1
- package/dist/models/metric-type.d.ts +1 -6
- package/dist/models/metric-type.js +1 -6
- package/dist/models/metric-update.d.ts +3 -35
- package/dist/models/metric-update.js +1 -1
- package/dist/models/objective-create.d.ts +1 -10
- package/dist/models/objective-create.js +1 -1
- package/dist/models/objective-response.d.ts +1 -30
- package/dist/models/objective-response.js +1 -1
- package/dist/models/objective-update.d.ts +1 -13
- package/dist/models/objective-update.js +1 -1
- package/dist/models/objective-weight-create.d.ts +1 -9
- package/dist/models/objective-weight-create.js +1 -1
- package/dist/models/objective-weight-response.d.ts +1 -14
- package/dist/models/objective-weight-response.js +1 -1
- package/dist/models/objective-weight-update.d.ts +1 -8
- package/dist/models/objective-weight-update.js +1 -1
- package/dist/models/option-create.d.ts +33 -0
- package/dist/models/option-create.js +15 -0
- package/dist/models/option-response.d.ts +31 -0
- package/dist/models/option-response.js +15 -0
- package/dist/models/option-update.d.ts +19 -0
- package/dist/models/option-update.js +15 -0
- package/dist/models/validation-error.d.ts +3 -33
- package/dist/models/validation-error.js +1 -1
- package/dist/models/value-framework-create.d.ts +1 -10
- package/dist/models/value-framework-create.js +1 -1
- package/dist/models/value-framework-response.d.ts +1 -30
- package/dist/models/value-framework-response.js +1 -1
- package/dist/models/value-framework-update.d.ts +1 -13
- package/dist/models/value-framework-update.js +1 -1
- package/docs/DefaultApi.md +51 -0
- package/docs/EvolutionType.md +10 -0
- package/docs/HTTPValidationError.md +20 -0
- package/docs/ImpactAPIResponse.md +39 -0
- package/docs/ImpactApi.md +312 -0
- package/docs/ImpactCreate.md +29 -0
- package/docs/ImpactUpdate.md +29 -0
- package/docs/InvestmentApi.md +875 -0
- package/docs/InvestmentCreate.md +23 -0
- package/docs/InvestmentResponse.md +31 -0
- package/docs/InvestmentUpdate.md +23 -0
- package/docs/LocationInner.md +18 -0
- package/docs/MeasurementType.md +10 -0
- package/docs/MetricApi.md +299 -0
- package/docs/MetricCostsApi.md +66 -0
- package/docs/MetricCostsPerYearApi.md +307 -0
- package/docs/MetricCostsPerYearCreate.md +27 -0
- package/docs/MetricCostsPerYearResponse.md +31 -0
- package/docs/MetricCostsPerYearUpdate.md +23 -0
- package/docs/MetricCreate.md +33 -0
- package/docs/MetricResponse.md +43 -0
- package/docs/MetricType.md +12 -0
- package/docs/MetricUpdate.md +31 -0
- package/docs/ObjectiveApi.md +633 -0
- package/docs/ObjectiveCreate.md +23 -0
- package/docs/ObjectiveResponse.md +31 -0
- package/docs/ObjectiveUpdate.md +23 -0
- package/docs/ObjectiveWeightApi.md +298 -0
- package/docs/ObjectiveWeightCreate.md +25 -0
- package/docs/ObjectiveWeightResponse.md +27 -0
- package/docs/ObjectiveWeightUpdate.md +21 -0
- package/docs/ObjectiveWeightsApi.md +66 -0
- package/docs/OptionApi.md +602 -0
- package/docs/OptionCreate.md +29 -0
- package/docs/OptionResponse.md +37 -0
- package/docs/OptionUpdate.md +25 -0
- package/docs/ValidationError.md +28 -0
- package/docs/ValueFrameworkApi.md +1053 -0
- package/docs/ValueFrameworkCostsApi.md +128 -0
- package/docs/ValueFrameworkCreate.md +23 -0
- package/docs/ValueFrameworkResponse.md +31 -0
- package/docs/ValueFrameworkUpdate.md +23 -0
- package/docs/ValueFrameworkWeightsApi.md +66 -0
- package/index.ts +1 -1
- package/models/evolution-type.ts +26 -0
- package/models/httpvalidation-error.ts +2 -12
- package/models/impact-apiresponse.ts +43 -0
- package/models/impact-create.ts +47 -0
- package/models/impact-update.ts +32 -0
- package/models/index.ts +11 -1
- package/models/investment-create.ts +27 -0
- package/models/investment-response.ts +31 -0
- package/models/investment-update.ts +24 -0
- package/models/{validation-error-loc-inner.ts → location-inner.ts} +2 -7
- package/models/measurement-type.ts +1 -6
- package/models/metric-costs-per-year-create.ts +1 -17
- package/models/metric-costs-per-year-response.ts +1 -18
- package/models/metric-costs-per-year-update.ts +1 -13
- package/models/metric-create.ts +3 -28
- package/models/metric-response.ts +3 -50
- package/models/metric-type.ts +1 -6
- package/models/metric-update.ts +3 -35
- package/models/objective-create.ts +1 -10
- package/models/objective-response.ts +1 -30
- package/models/objective-update.ts +1 -13
- package/models/objective-weight-create.ts +1 -9
- package/models/objective-weight-response.ts +1 -14
- package/models/objective-weight-update.ts +1 -8
- package/models/option-create.ts +39 -0
- package/models/option-response.ts +37 -0
- package/models/option-update.ts +25 -0
- package/models/validation-error.ts +3 -33
- package/models/value-framework-create.ts +1 -10
- package/models/value-framework-response.ts +1 -30
- package/models/value-framework-update.ts +1 -13
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @cosmotech/aip-client@0.2.0-
|
|
1
|
+
## @cosmotech/aip-client@0.2.0-dev3
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -15,7 +15,7 @@ Module system
|
|
|
15
15
|
* CommonJS
|
|
16
16
|
* ES6 module system
|
|
17
17
|
|
|
18
|
-
It can be used in both TypeScript and JavaScript. In TypeScript, the definition
|
|
18
|
+
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
|
|
19
19
|
|
|
20
20
|
### Building
|
|
21
21
|
|
|
@@ -27,7 +27,7 @@ npm run build
|
|
|
27
27
|
|
|
28
28
|
### Publishing
|
|
29
29
|
|
|
30
|
-
First build the package then run
|
|
30
|
+
First build the package then run `npm publish`
|
|
31
31
|
|
|
32
32
|
### Consuming
|
|
33
33
|
|
|
@@ -36,10 +36,147 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @cosmotech/aip-client@0.2.0-
|
|
39
|
+
npm install @cosmotech/aip-client@0.2.0-dev3 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
43
43
|
|
|
44
44
|
```
|
|
45
45
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Documentation for API Endpoints
|
|
49
|
+
|
|
50
|
+
All URIs are relative to *http://localhost*
|
|
51
|
+
|
|
52
|
+
Class | Method | HTTP request | Description
|
|
53
|
+
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*DefaultApi* | [**root**](docs/DefaultApi.md#root) | **GET** /about | Root
|
|
55
|
+
*ImpactApi* | [**createImpactForOption**](docs/ImpactApi.md#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option
|
|
56
|
+
*ImpactApi* | [**deleteImpactForOption**](docs/ImpactApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
|
|
57
|
+
*ImpactApi* | [**getImpactForOption**](docs/ImpactApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
|
|
58
|
+
*ImpactApi* | [**getImpactsForOption**](docs/ImpactApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
|
|
59
|
+
*ImpactApi* | [**patchImpactForOption**](docs/ImpactApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
|
|
60
|
+
*InvestmentApi* | [**createImpactForOption**](docs/InvestmentApi.md#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option
|
|
61
|
+
*InvestmentApi* | [**createOptionForInvestment**](docs/InvestmentApi.md#createoptionforinvestment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment
|
|
62
|
+
*InvestmentApi* | [**deleteImpactForOption**](docs/InvestmentApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
|
|
63
|
+
*InvestmentApi* | [**deleteInvestment**](docs/InvestmentApi.md#deleteinvestment) | **DELETE** /investment/{investment_id} | Delete an investment
|
|
64
|
+
*InvestmentApi* | [**deleteOptionForInvestment**](docs/InvestmentApi.md#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment
|
|
65
|
+
*InvestmentApi* | [**getImpactForOption**](docs/InvestmentApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
|
|
66
|
+
*InvestmentApi* | [**getImpactsForOption**](docs/InvestmentApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
|
|
67
|
+
*InvestmentApi* | [**getInvestmentById**](docs/InvestmentApi.md#getinvestmentbyid) | **GET** /investment/{investment_id} | Get an investment by ID
|
|
68
|
+
*InvestmentApi* | [**getInvestments**](docs/InvestmentApi.md#getinvestments) | **GET** /investment/ | List investments
|
|
69
|
+
*InvestmentApi* | [**getOptionForInvestment**](docs/InvestmentApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
|
|
70
|
+
*InvestmentApi* | [**getOptionsForInvestment**](docs/InvestmentApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
|
|
71
|
+
*InvestmentApi* | [**patchImpactForOption**](docs/InvestmentApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
|
|
72
|
+
*InvestmentApi* | [**patchInvestment**](docs/InvestmentApi.md#patchinvestment) | **PATCH** /investment/{investment_id} | Partially update an investment
|
|
73
|
+
*InvestmentApi* | [**patchOptionForInvestment**](docs/InvestmentApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
|
|
74
|
+
*InvestmentApi* | [**postInvestment**](docs/InvestmentApi.md#postinvestment) | **POST** /investment/ | Create an investment
|
|
75
|
+
*MetricApi* | [**createMetricForObjective**](docs/MetricApi.md#createmetricforobjective) | **POST** /objective/{objective_id}/metric/ | Create a metric for this objective
|
|
76
|
+
*MetricApi* | [**deleteMetricForObjective**](docs/MetricApi.md#deletemetricforobjective) | **DELETE** /objective/{objective_id}/metric/{metric_id} | Delete a metric for this objective
|
|
77
|
+
*MetricApi* | [**getMetricForObjective**](docs/MetricApi.md#getmetricforobjective) | **GET** /objective/{objective_id}/metric/{metric_id} | Get a metric for this objective
|
|
78
|
+
*MetricApi* | [**getMetricsForObjective**](docs/MetricApi.md#getmetricsforobjective) | **GET** /objective/{objective_id}/metric/ | List metrics for this objective
|
|
79
|
+
*MetricApi* | [**patchMetricForObjective**](docs/MetricApi.md#patchmetricforobjective) | **PATCH** /objective/{objective_id}/metric/{metric_id} | Partially update a metric for this objective
|
|
80
|
+
*MetricCostsApi* | [**getCostsForMetric**](docs/MetricCostsApi.md#getcostsformetric) | **GET** /metric/{metric_id}/costs/ | List all metric costs for a metric
|
|
81
|
+
*MetricCostsPerYearApi* | [**createMetricCostForFramework**](docs/MetricCostsPerYearApi.md#createmetriccostforframework) | **POST** /value_framework/{value_framework_id}/metric_costs_per_year/ | Create a yearly metric cost for this framework
|
|
82
|
+
*MetricCostsPerYearApi* | [**deleteMetricCostForFramework**](docs/MetricCostsPerYearApi.md#deletemetriccostforframework) | **DELETE** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Delete metric costs for this framework
|
|
83
|
+
*MetricCostsPerYearApi* | [**getMetricCostForFramework**](docs/MetricCostsPerYearApi.md#getmetriccostforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Get a yearly metric cost for this framework
|
|
84
|
+
*MetricCostsPerYearApi* | [**getMetricCostsForFramework**](docs/MetricCostsPerYearApi.md#getmetriccostsforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/ | List yearly metric costs for this framework
|
|
85
|
+
*MetricCostsPerYearApi* | [**patchMetricCostForFramework**](docs/MetricCostsPerYearApi.md#patchmetriccostforframework) | **PATCH** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Partially update metric costs for this framework
|
|
86
|
+
*ObjectiveApi* | [**createMetricForObjective**](docs/ObjectiveApi.md#createmetricforobjective) | **POST** /objective/{objective_id}/metric/ | Create a metric for this objective
|
|
87
|
+
*ObjectiveApi* | [**deleteMetricForObjective**](docs/ObjectiveApi.md#deletemetricforobjective) | **DELETE** /objective/{objective_id}/metric/{metric_id} | Delete a metric for this objective
|
|
88
|
+
*ObjectiveApi* | [**deleteObjective**](docs/ObjectiveApi.md#deleteobjective) | **DELETE** /objective/{objective_id} | Delete an objective
|
|
89
|
+
*ObjectiveApi* | [**getMetricForObjective**](docs/ObjectiveApi.md#getmetricforobjective) | **GET** /objective/{objective_id}/metric/{metric_id} | Get a metric for this objective
|
|
90
|
+
*ObjectiveApi* | [**getMetricsForObjective**](docs/ObjectiveApi.md#getmetricsforobjective) | **GET** /objective/{objective_id}/metric/ | List metrics for this objective
|
|
91
|
+
*ObjectiveApi* | [**getObjectiveById**](docs/ObjectiveApi.md#getobjectivebyid) | **GET** /objective/{objective_id} | Get an objective by ID
|
|
92
|
+
*ObjectiveApi* | [**getObjectives**](docs/ObjectiveApi.md#getobjectives) | **GET** /objective/ | List objectives
|
|
93
|
+
*ObjectiveApi* | [**getWeightsForObjective**](docs/ObjectiveApi.md#getweightsforobjective) | **GET** /objective/{objective_id}/weights/ | List all objective weights for an objective
|
|
94
|
+
*ObjectiveApi* | [**patchMetricForObjective**](docs/ObjectiveApi.md#patchmetricforobjective) | **PATCH** /objective/{objective_id}/metric/{metric_id} | Partially update a metric for this objective
|
|
95
|
+
*ObjectiveApi* | [**patchObjective**](docs/ObjectiveApi.md#patchobjective) | **PATCH** /objective/{objective_id} | Partially update an objective
|
|
96
|
+
*ObjectiveApi* | [**postObjective**](docs/ObjectiveApi.md#postobjective) | **POST** /objective/ | Create an objective
|
|
97
|
+
*ObjectiveWeightApi* | [**createObjectiveWeightForFramework**](docs/ObjectiveWeightApi.md#createobjectiveweightforframework) | **POST** /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework
|
|
98
|
+
*ObjectiveWeightApi* | [**deleteObjectiveWeightForFramework**](docs/ObjectiveWeightApi.md#deleteobjectiveweightforframework) | **DELETE** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Delete an objective weight for this framework
|
|
99
|
+
*ObjectiveWeightApi* | [**getObjectiveWeightForFramework**](docs/ObjectiveWeightApi.md#getobjectiveweightforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Get an objective weight for this framework
|
|
100
|
+
*ObjectiveWeightApi* | [**getObjectiveWeightsForFramework**](docs/ObjectiveWeightApi.md#getobjectiveweightsforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/ | List objective weights for this framework
|
|
101
|
+
*ObjectiveWeightApi* | [**patchObjectiveWeightForFramework**](docs/ObjectiveWeightApi.md#patchobjectiveweightforframework) | **PATCH** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Partially update an objective weight for this framework
|
|
102
|
+
*ObjectiveWeightsApi* | [**getWeightsForObjective**](docs/ObjectiveWeightsApi.md#getweightsforobjective) | **GET** /objective/{objective_id}/weights/ | List all objective weights for an objective
|
|
103
|
+
*OptionApi* | [**createImpactForOption**](docs/OptionApi.md#createimpactforoption) | **POST** /investment/{investment_id}/option/{option_id}/impact/ | Create an impact for this option
|
|
104
|
+
*OptionApi* | [**createOptionForInvestment**](docs/OptionApi.md#createoptionforinvestment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment
|
|
105
|
+
*OptionApi* | [**deleteImpactForOption**](docs/OptionApi.md#deleteimpactforoption) | **DELETE** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Delete an impact for this option
|
|
106
|
+
*OptionApi* | [**deleteOptionForInvestment**](docs/OptionApi.md#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment
|
|
107
|
+
*OptionApi* | [**getImpactForOption**](docs/OptionApi.md#getimpactforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Get an impact for this option
|
|
108
|
+
*OptionApi* | [**getImpactsForOption**](docs/OptionApi.md#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option
|
|
109
|
+
*OptionApi* | [**getOptionForInvestment**](docs/OptionApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
|
|
110
|
+
*OptionApi* | [**getOptionsForInvestment**](docs/OptionApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
|
|
111
|
+
*OptionApi* | [**patchImpactForOption**](docs/OptionApi.md#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option
|
|
112
|
+
*OptionApi* | [**patchOptionForInvestment**](docs/OptionApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
|
|
113
|
+
*ValueFrameworkApi* | [**createMetricCostForFramework**](docs/ValueFrameworkApi.md#createmetriccostforframework) | **POST** /value_framework/{value_framework_id}/metric_costs_per_year/ | Create a yearly metric cost for this framework
|
|
114
|
+
*ValueFrameworkApi* | [**createObjectiveWeightForFramework**](docs/ValueFrameworkApi.md#createobjectiveweightforframework) | **POST** /value_framework/{value_framework_id}/objective_weight/ | Create an objective weight for this framework
|
|
115
|
+
*ValueFrameworkApi* | [**deleteMetricCostForFramework**](docs/ValueFrameworkApi.md#deletemetriccostforframework) | **DELETE** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Delete metric costs for this framework
|
|
116
|
+
*ValueFrameworkApi* | [**deleteObjectiveWeightForFramework**](docs/ValueFrameworkApi.md#deleteobjectiveweightforframework) | **DELETE** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Delete an objective weight for this framework
|
|
117
|
+
*ValueFrameworkApi* | [**deleteValueFramework**](docs/ValueFrameworkApi.md#deletevalueframework) | **DELETE** /value_framework/{value_framework_id} | Delete a value framework
|
|
118
|
+
*ValueFrameworkApi* | [**getCostsForValueFramework**](docs/ValueFrameworkApi.md#getcostsforvalueframework) | **GET** /value_framework/{value_framework_id}/costs/ | List all metric costs for a value framework
|
|
119
|
+
*ValueFrameworkApi* | [**getCostsForValueFrameworkByMetric**](docs/ValueFrameworkApi.md#getcostsforvalueframeworkbymetric) | **GET** /value_framework/{value_framework_id}/costs/{metric_id} | List metric costs for a value framework filtered by metric
|
|
120
|
+
*ValueFrameworkApi* | [**getMetricCostForFramework**](docs/ValueFrameworkApi.md#getmetriccostforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Get a yearly metric cost for this framework
|
|
121
|
+
*ValueFrameworkApi* | [**getMetricCostsForFramework**](docs/ValueFrameworkApi.md#getmetriccostsforframework) | **GET** /value_framework/{value_framework_id}/metric_costs_per_year/ | List yearly metric costs for this framework
|
|
122
|
+
*ValueFrameworkApi* | [**getObjectiveWeightForFramework**](docs/ValueFrameworkApi.md#getobjectiveweightforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Get an objective weight for this framework
|
|
123
|
+
*ValueFrameworkApi* | [**getObjectiveWeightsForFramework**](docs/ValueFrameworkApi.md#getobjectiveweightsforframework) | **GET** /value_framework/{value_framework_id}/objective_weight/ | List objective weights for this framework
|
|
124
|
+
*ValueFrameworkApi* | [**getValueFrameworkById**](docs/ValueFrameworkApi.md#getvalueframeworkbyid) | **GET** /value_framework/{value_framework_id} | Get a value framework by ID
|
|
125
|
+
*ValueFrameworkApi* | [**getValueFrameworks**](docs/ValueFrameworkApi.md#getvalueframeworks) | **GET** /value_framework/ | List value frameworks
|
|
126
|
+
*ValueFrameworkApi* | [**getWeightsForValueFramework**](docs/ValueFrameworkApi.md#getweightsforvalueframework) | **GET** /value_framework/{value_framework_id}/weights/ | List all objective weights for a value framework
|
|
127
|
+
*ValueFrameworkApi* | [**patchMetricCostForFramework**](docs/ValueFrameworkApi.md#patchmetriccostforframework) | **PATCH** /value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year} | Partially update metric costs for this framework
|
|
128
|
+
*ValueFrameworkApi* | [**patchObjectiveWeightForFramework**](docs/ValueFrameworkApi.md#patchobjectiveweightforframework) | **PATCH** /value_framework/{value_framework_id}/objective_weight/{objective_id} | Partially update an objective weight for this framework
|
|
129
|
+
*ValueFrameworkApi* | [**patchValueFramework**](docs/ValueFrameworkApi.md#patchvalueframework) | **PATCH** /value_framework/{value_framework_id} | Partially update a value framework
|
|
130
|
+
*ValueFrameworkApi* | [**postValueFramework**](docs/ValueFrameworkApi.md#postvalueframework) | **POST** /value_framework/ | Create a value framework
|
|
131
|
+
*ValueFrameworkCostsApi* | [**getCostsForValueFramework**](docs/ValueFrameworkCostsApi.md#getcostsforvalueframework) | **GET** /value_framework/{value_framework_id}/costs/ | List all metric costs for a value framework
|
|
132
|
+
*ValueFrameworkCostsApi* | [**getCostsForValueFrameworkByMetric**](docs/ValueFrameworkCostsApi.md#getcostsforvalueframeworkbymetric) | **GET** /value_framework/{value_framework_id}/costs/{metric_id} | List metric costs for a value framework filtered by metric
|
|
133
|
+
*ValueFrameworkWeightsApi* | [**getWeightsForValueFramework**](docs/ValueFrameworkWeightsApi.md#getweightsforvalueframework) | **GET** /value_framework/{value_framework_id}/weights/ | List all objective weights for a value framework
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
### Documentation For Models
|
|
137
|
+
|
|
138
|
+
- [EvolutionType](docs/EvolutionType.md)
|
|
139
|
+
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
140
|
+
- [ImpactAPIResponse](docs/ImpactAPIResponse.md)
|
|
141
|
+
- [ImpactCreate](docs/ImpactCreate.md)
|
|
142
|
+
- [ImpactUpdate](docs/ImpactUpdate.md)
|
|
143
|
+
- [InvestmentCreate](docs/InvestmentCreate.md)
|
|
144
|
+
- [InvestmentResponse](docs/InvestmentResponse.md)
|
|
145
|
+
- [InvestmentUpdate](docs/InvestmentUpdate.md)
|
|
146
|
+
- [LocationInner](docs/LocationInner.md)
|
|
147
|
+
- [MeasurementType](docs/MeasurementType.md)
|
|
148
|
+
- [MetricCostsPerYearCreate](docs/MetricCostsPerYearCreate.md)
|
|
149
|
+
- [MetricCostsPerYearResponse](docs/MetricCostsPerYearResponse.md)
|
|
150
|
+
- [MetricCostsPerYearUpdate](docs/MetricCostsPerYearUpdate.md)
|
|
151
|
+
- [MetricCreate](docs/MetricCreate.md)
|
|
152
|
+
- [MetricResponse](docs/MetricResponse.md)
|
|
153
|
+
- [MetricType](docs/MetricType.md)
|
|
154
|
+
- [MetricUpdate](docs/MetricUpdate.md)
|
|
155
|
+
- [ObjectiveCreate](docs/ObjectiveCreate.md)
|
|
156
|
+
- [ObjectiveResponse](docs/ObjectiveResponse.md)
|
|
157
|
+
- [ObjectiveUpdate](docs/ObjectiveUpdate.md)
|
|
158
|
+
- [ObjectiveWeightCreate](docs/ObjectiveWeightCreate.md)
|
|
159
|
+
- [ObjectiveWeightResponse](docs/ObjectiveWeightResponse.md)
|
|
160
|
+
- [ObjectiveWeightUpdate](docs/ObjectiveWeightUpdate.md)
|
|
161
|
+
- [OptionCreate](docs/OptionCreate.md)
|
|
162
|
+
- [OptionResponse](docs/OptionResponse.md)
|
|
163
|
+
- [OptionUpdate](docs/OptionUpdate.md)
|
|
164
|
+
- [ValidationError](docs/ValidationError.md)
|
|
165
|
+
- [ValueFrameworkCreate](docs/ValueFrameworkCreate.md)
|
|
166
|
+
- [ValueFrameworkResponse](docs/ValueFrameworkResponse.md)
|
|
167
|
+
- [ValueFrameworkUpdate](docs/ValueFrameworkUpdate.md)
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<a id="documentation-for-authorization"></a>
|
|
171
|
+
## Documentation For Authorization
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
Authentication schemes defined for the API:
|
|
175
|
+
<a id="OAuth2AuthorizationCodeBearer"></a>
|
|
176
|
+
### OAuth2AuthorizationCodeBearer
|
|
177
|
+
|
|
178
|
+
- **Type**: OAuth
|
|
179
|
+
- **Flow**: accessCode
|
|
180
|
+
- **Authorization URL**: None/protocol/openid-connect/auth
|
|
181
|
+
- **Scopes**: N/A
|
|
182
|
+
|
package/api/default-api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Asset Investment Planning
|
|
5
5
|
* API for Asset Investment Planning
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.2.0-
|
|
7
|
+
* The version of the OpenAPI document: 0.2.0-dev3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -18,12 +18,11 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
18
18
|
import globalAxios from 'axios';
|
|
19
19
|
// Some imports not used depending on template conditions
|
|
20
20
|
// @ts-ignore
|
|
21
|
-
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
22
22
|
// @ts-ignore
|
|
23
|
-
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
24
|
/**
|
|
25
25
|
* DefaultApi - axios parameter creator
|
|
26
|
-
* @export
|
|
27
26
|
*/
|
|
28
27
|
export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
29
28
|
return {
|
|
@@ -46,8 +45,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
46
45
|
const localVarHeaderParameter = {} as any;
|
|
47
46
|
const localVarQueryParameter = {} as any;
|
|
48
47
|
|
|
48
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
49
49
|
|
|
50
|
-
|
|
51
50
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
52
51
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
53
52
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -62,7 +61,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
62
61
|
|
|
63
62
|
/**
|
|
64
63
|
* DefaultApi - functional programming interface
|
|
65
|
-
* @export
|
|
66
64
|
*/
|
|
67
65
|
export const DefaultApiFp = function(configuration?: Configuration) {
|
|
68
66
|
const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
|
|
@@ -75,16 +73,15 @@ export const DefaultApiFp = function(configuration?: Configuration) {
|
|
|
75
73
|
*/
|
|
76
74
|
async root(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
77
75
|
const localVarAxiosArgs = await localVarAxiosParamCreator.root(options);
|
|
78
|
-
const
|
|
79
|
-
const
|
|
80
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios,
|
|
76
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
77
|
+
const localVarOperationServerBasePath = operationServerMap['DefaultApi.root']?.[localVarOperationServerIndex]?.url;
|
|
78
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
81
79
|
},
|
|
82
80
|
}
|
|
83
81
|
};
|
|
84
82
|
|
|
85
83
|
/**
|
|
86
84
|
* DefaultApi - factory interface
|
|
87
|
-
* @export
|
|
88
85
|
*/
|
|
89
86
|
export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
90
87
|
const localVarFp = DefaultApiFp(configuration)
|
|
@@ -95,7 +92,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
95
92
|
* @param {*} [options] Override http request option.
|
|
96
93
|
* @throws {RequiredError}
|
|
97
94
|
*/
|
|
98
|
-
root(options?:
|
|
95
|
+
root(options?: RawAxiosRequestConfig): AxiosPromise<any> {
|
|
99
96
|
return localVarFp.root(options).then((request) => request(axios, basePath));
|
|
100
97
|
},
|
|
101
98
|
};
|
|
@@ -103,9 +100,6 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
|
|
|
103
100
|
|
|
104
101
|
/**
|
|
105
102
|
* DefaultApi - object-oriented interface
|
|
106
|
-
* @export
|
|
107
|
-
* @class DefaultApi
|
|
108
|
-
* @extends {BaseAPI}
|
|
109
103
|
*/
|
|
110
104
|
export class DefaultApi extends BaseAPI {
|
|
111
105
|
/**
|
|
@@ -113,7 +107,6 @@ export class DefaultApi extends BaseAPI {
|
|
|
113
107
|
* @summary Root
|
|
114
108
|
* @param {*} [options] Override http request option.
|
|
115
109
|
* @throws {RequiredError}
|
|
116
|
-
* @memberof DefaultApi
|
|
117
110
|
*/
|
|
118
111
|
public root(options?: RawAxiosRequestConfig) {
|
|
119
112
|
return DefaultApiFp(this.configuration).root(options).then((request) => request(this.axios, this.basePath));
|