@cosmotech/aip-client 0.4.0-dev5 → 1.0.0-dev2

package/README.md

@@ -1,4 +1,4 @@
-## @cosmotech/aip-client@0.4.0-dev5
+## @cosmotech/aip-client@1.0.0-dev2
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @cosmotech/aip-client@0.4.0-dev5 --save
+npm install @cosmotech/aip-client@1.0.0-dev2 --save
 ```
 
 _unPublished (not recommended):_
@@ -133,6 +133,19 @@ Class | Method | HTTP request | Description
 *PortfolioKPIApi* | [**getPortfolioMonetizedImpactDetailed**](docs/PortfolioKPIApi.md#getportfoliomonetizedimpactdetailed) | **GET** /portfolio/{portfolio_id}/monetized-impact/detailed | Portfolio monetized impact over time (split by metric)
 *PreferredOptionApi* | [**getPreferredOption**](docs/PreferredOptionApi.md#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment
 *PreferredOptionApi* | [**setPreferredOption**](docs/PreferredOptionApi.md#setpreferredoption) | **POST** /investment/{investment_id}/preferred_option | Set the preferred option for an investment
+*PrioritizationApi* | [**abortScenario**](docs/PrioritizationApi.md#abortscenario) | **POST** /portfolio/{portfolio_id}/scenario/abort | Abort a running prioritization
+*PrioritizationApi* | [**deleteScenario**](docs/PrioritizationApi.md#deletescenario) | **DELETE** /portfolio/{portfolio_id}/scenario/ | Delete the prioritization scenario
+*PrioritizationApi* | [**getScenario**](docs/PrioritizationApi.md#getscenario) | **GET** /portfolio/{portfolio_id}/scenario/ | Get the prioritization scenario
+*PrioritizationApi* | [**getScenarioBudgetExpenditure**](docs/PrioritizationApi.md#getscenariobudgetexpenditure) | **GET** /portfolio/{portfolio_id}/scenario/budget-expenditure/{budget_id} | Per-year expenditure for one budget (performed investments)
+*PrioritizationApi* | [**getScenarioBudgetExpenditureAll**](docs/PrioritizationApi.md#getscenariobudgetexpenditureall) | **GET** /portfolio/{portfolio_id}/scenario/budget-expenditure-all | Per-budget expenditure for performed investments
+*PrioritizationApi* | [**getScenarioBudgetExpenditureNoBudget**](docs/PrioritizationApi.md#getscenariobudgetexpenditurenobudget) | **GET** /portfolio/{portfolio_id}/scenario/budget-expenditure-no-budget | Per-year expenditure for performed investments with no budget
+*PrioritizationApi* | [**getScenarioBudgetUsage**](docs/PrioritizationApi.md#getscenariobudgetusage) | **GET** /portfolio/{portfolio_id}/scenario/budget-usage | Budget usage for performed investments
+*PrioritizationApi* | [**getScenarioOverview**](docs/PrioritizationApi.md#getscenariooverview) | **GET** /portfolio/{portfolio_id}/scenario/overview | Run vs portfolio comparison KPIs
+*PrioritizationApi* | [**getScenarioResults**](docs/PrioritizationApi.md#getscenarioresults) | **GET** /portfolio/{portfolio_id}/scenario/results | Get prioritization results
+*PrioritizationApi* | [**getScenarioStatus**](docs/PrioritizationApi.md#getscenariostatus) | **GET** /portfolio/{portfolio_id}/scenario/status | Get prioritization run status
+*PrioritizationApi* | [**getScenarioValueFrameworkImpact**](docs/PrioritizationApi.md#getscenariovalueframeworkimpact) | **GET** /portfolio/{portfolio_id}/scenario/value-framework-impact | Monetized impact filtered to performed investments
+*PrioritizationApi* | [**getScenarioValueFrameworkImpactDetailed**](docs/PrioritizationApi.md#getscenariovalueframeworkimpactdetailed) | **GET** /portfolio/{portfolio_id}/scenario/value-framework-impact/detailed | Monetized impact (split by metric) filtered to performed investments
+*PrioritizationApi* | [**runScenario**](docs/PrioritizationApi.md#runscenario) | **POST** /portfolio/{portfolio_id}/scenario/run | Create/update and run a prioritization scenario
 *ValueFrameworkApi* | [**deleteValueFramework**](docs/ValueFrameworkApi.md#deletevalueframework) | **DELETE** /value_framework/{value_framework_id} | Delete a value framework
 *ValueFrameworkApi* | [**getValueFrameworkById**](docs/ValueFrameworkApi.md#getvalueframeworkbyid) | **GET** /value_framework/{value_framework_id} | Get a value framework by ID
 *ValueFrameworkApi* | [**getValueFrameworks**](docs/ValueFrameworkApi.md#getvalueframeworks) | **GET** /value_framework/ | List value frameworks
@@ -213,6 +226,13 @@ Class | Method | HTTP request | Description
  - [PortfolioUpdate](docs/PortfolioUpdate.md)
  - [PreferredOptionRequest](docs/PreferredOptionRequest.md)
  - [PreferredOptionResponse](docs/PreferredOptionResponse.md)
+ - [PrioritizationOverviewResponse](docs/PrioritizationOverviewResponse.md)
+ - [PrioritizationResultResponse](docs/PrioritizationResultResponse.md)
+ - [PrioritizationResultsResponse](docs/PrioritizationResultsResponse.md)
+ - [PrioritizationScenarioResponse](docs/PrioritizationScenarioResponse.md)
+ - [PrioritizationScenarioRunRequest](docs/PrioritizationScenarioRunRequest.md)
+ - [PrioritizationScenarioStatusResponse](docs/PrioritizationScenarioStatusResponse.md)
+ - [ScenarioStatus](docs/ScenarioStatus.md)
  - [ValidationError](docs/ValidationError.md)
  - [ValueFrameworkCreate](docs/ValueFrameworkCreate.md)
  - [ValueFrameworkResponse](docs/ValueFrameworkResponse.md)

package/api/budget-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/default-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/impact-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/investment-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/metric-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/metric-costs-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/metric-costs-per-year-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/objective-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/objective-weight-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/objective-weights-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/option-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -261,15 +261,13 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
          * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
          * @summary Option overview table for this investment
          * @param {string} investmentId UUID of the investment
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOptionsOverview: async (investmentId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getOptionsOverview: async (investmentId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'investmentId' is not null or undefined
             assertParamExists('getOptionsOverview', 'investmentId', investmentId)
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            assertParamExists('getOptionsOverview', 'valueFrameworkId', valueFrameworkId)
             const localVarPath = `/investment/{investment_id}/option/overview`
                 .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -434,11 +432,11 @@ export const OptionApiFp = function(configuration?: Configuration) {
          * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
          * @summary Option overview table for this investment
          * @param {string} investmentId UUID of the investment
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>> {
+        async getOptionsOverview(investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionsOverview(investmentId, valueFrameworkId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['OptionApi.getOptionsOverview']?.[localVarOperationServerIndex]?.url;
@@ -529,11 +527,11 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
          * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
          * @summary Option overview table for this investment
          * @param {string} investmentId UUID of the investment
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>> {
+        getOptionsOverview(investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>> {
             return localVarFp.getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
@@ -621,11 +619,11 @@ export class OptionApi extends BaseAPI {
      * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
      * @summary Option overview table for this investment
      * @param {string} investmentId UUID of the investment
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+    public getOptionsOverview(investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
         return OptionApiFp(this.configuration).getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
 

package/api/portfolio-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/portfolio-investment-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/portfolio-kpiapi.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/api/preferred-option-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).