@cosmotech/aip-client 0.4.0-dev4 → 1.0.0-dev1

package/README.md

@@ -1,4 +1,4 @@
-## @cosmotech/aip-client@0.4.0-dev4
+## @cosmotech/aip-client@1.0.0-dev1
 
 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-dev4 --save
+npm install @cosmotech/aip-client@1.0.0-dev1 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,12 +54,12 @@ Class | Method | HTTP request | Description
 *BudgetApi* | [**bulkDeleteBudgets**](docs/BudgetApi.md#bulkdeletebudgets) | **POST** /budget/bulk-delete | Bulk delete budgets
 *BudgetApi* | [**deleteBudget**](docs/BudgetApi.md#deletebudget) | **DELETE** /budget/{budget_id} | Delete a budget
 *BudgetApi* | [**getBudgetById**](docs/BudgetApi.md#getbudgetbyid) | **GET** /budget/{budget_id} | Get a budget by ID
-*BudgetApi* | [**getBudgetInvestments**](docs/BudgetApi.md#getbudgetinvestments) | **GET** /budget/{budget_id}/investments/{value_framework_id} | List investments linked to this budget via options
-*BudgetApi* | [**getBudgetOptions**](docs/BudgetApi.md#getbudgetoptions) | **GET** /budget/{budget_id}/options/{value_framework_id} | List options linked to this budget
+*BudgetApi* | [**getBudgetInvestments**](docs/BudgetApi.md#getbudgetinvestments) | **GET** /budget/{budget_id}/investments | List investments linked to this budget via options
+*BudgetApi* | [**getBudgetOptions**](docs/BudgetApi.md#getbudgetoptions) | **GET** /budget/{budget_id}/options | List options linked to this budget
 *BudgetApi* | [**getBudgetOverview**](docs/BudgetApi.md#getbudgetoverview) | **GET** /budget/{budget_id}/overview | Get budget overview
 *BudgetApi* | [**getBudgets**](docs/BudgetApi.md#getbudgets) | **GET** /budget/ | List all budgets
 *BudgetApi* | [**linkOptionsToBudget**](docs/BudgetApi.md#linkoptionstobudget) | **POST** /budget/{budget_id}/link-options | Bulk-link options to this budget
-*BudgetApi* | [**listAvailableOptions**](docs/BudgetApi.md#listavailableoptions) | **GET** /budget/list-available-options/{value_framework_id} | List all options available to be added to a budget
+*BudgetApi* | [**listAvailableOptions**](docs/BudgetApi.md#listavailableoptions) | **GET** /budget/list-available-options | List all options available to be added to a budget
 *BudgetApi* | [**patchBudget**](docs/BudgetApi.md#patchbudget) | **PATCH** /budget/{budget_id} | Partially update a budget
 *BudgetApi* | [**postBudget**](docs/BudgetApi.md#postbudget) | **POST** /budget/ | Create a budget
 *DefaultApi* | [**root**](docs/DefaultApi.md#root) | **GET** /about | Root
@@ -101,7 +101,7 @@ Class | Method | HTTP request | Description
 *OptionApi* | [**createOptionForInvestment**](docs/OptionApi.md#createoptionforinvestment) | **POST** /investment/{investment_id}/option/ | Create an option for this investment
 *OptionApi* | [**deleteOptionForInvestment**](docs/OptionApi.md#deleteoptionforinvestment) | **DELETE** /investment/{investment_id}/option/{option_id} | Delete an option for this investment
 *OptionApi* | [**getOptionForInvestment**](docs/OptionApi.md#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment
-*OptionApi* | [**getOptionKpis**](docs/OptionApi.md#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework
+*OptionApi* | [**getOptionKpis**](docs/OptionApi.md#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis | Get the kpis for a given option inside a value framework
 *OptionApi* | [**getOptionsForInvestment**](docs/OptionApi.md#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment
 *OptionApi* | [**getOptionsOverview**](docs/OptionApi.md#getoptionsoverview) | **GET** /investment/{investment_id}/option/overview | Option overview table for this investment
 *OptionApi* | [**patchOptionForInvestment**](docs/OptionApi.md#patchoptionforinvestment) | **PATCH** /investment/{investment_id}/option/{option_id} | Partially update an option for this investment
@@ -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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -159,18 +159,15 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
          * Return all distinct investments that have at least one option linked to this budget. Each row shows the investment\'s current preferred option data and a flag indicating whether the preferred option is the one linked to the budget. NPV is computed for the preferred option from the v_option_npv view.
          * @summary List investments linked to this budget via options
          * @param {string} budgetId UUID of the budget
-         * @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}
          */
-        getBudgetInvestments: async (budgetId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getBudgetInvestments: async (budgetId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'budgetId' is not null or undefined
             assertParamExists('getBudgetInvestments', 'budgetId', budgetId)
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            assertParamExists('getBudgetInvestments', 'valueFrameworkId', valueFrameworkId)
-            const localVarPath = `/budget/{budget_id}/investments/{value_framework_id}`
-                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)))
-                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            const localVarPath = `/budget/{budget_id}/investments`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -186,6 +183,10 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
             // oauth required
             await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
 
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
             localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -201,18 +202,15 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
          * Return all options linked to this budget. Rows are ordered by investment name then option name. NPV is computed from the v_option_npv view for the given value framework.
          * @summary List options linked to this budget
          * @param {string} budgetId UUID of the budget
-         * @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}
          */
-        getBudgetOptions: async (budgetId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getBudgetOptions: async (budgetId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'budgetId' is not null or undefined
             assertParamExists('getBudgetOptions', 'budgetId', budgetId)
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            assertParamExists('getBudgetOptions', 'valueFrameworkId', valueFrameworkId)
-            const localVarPath = `/budget/{budget_id}/options/{value_framework_id}`
-                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)))
-                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+            const localVarPath = `/budget/{budget_id}/options`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -228,6 +226,10 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
             // oauth required
             await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
 
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
             localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -365,17 +367,14 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
             };
         },
         /**
-         * Returns a list of all options, with their investment context and NPV.
+         * Returns a list of all options, with their investment context and NPV. If value_framework_id is omitted, NPV will be null for all options.
          * @summary List all options available to be added to a budget
-         * @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}
          */
-        listAvailableOptions: async (valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            assertParamExists('listAvailableOptions', 'valueFrameworkId', valueFrameworkId)
-            const localVarPath = `/budget/list-available-options/{value_framework_id}`
-                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+        listAvailableOptions: async (valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/budget/list-available-options`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -391,6 +390,10 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
             // oauth required
             await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
 
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
             localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -536,11 +539,11 @@ export const BudgetApiFp = function(configuration?: Configuration) {
          * Return all distinct investments that have at least one option linked to this budget. Each row shows the investment\'s current preferred option data and a flag indicating whether the preferred option is the one linked to the budget. NPV is computed for the preferred option from the v_option_npv view.
          * @summary List investments linked to this budget via options
          * @param {string} budgetId UUID of the budget
-         * @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 getBudgetInvestments(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetInvestmentResponse>>> {
+        async getBudgetInvestments(budgetId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetInvestmentResponse>>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getBudgetInvestments(budgetId, valueFrameworkId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['BudgetApi.getBudgetInvestments']?.[localVarOperationServerIndex]?.url;
@@ -550,11 +553,11 @@ export const BudgetApiFp = function(configuration?: Configuration) {
          * Return all options linked to this budget. Rows are ordered by investment name then option name. NPV is computed from the v_option_npv view for the given value framework.
          * @summary List options linked to this budget
          * @param {string} budgetId UUID of the budget
-         * @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 getBudgetOptions(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetOptionResponse>>> {
+        async getBudgetOptions(budgetId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetOptionResponse>>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getBudgetOptions(budgetId, valueFrameworkId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['BudgetApi.getBudgetOptions']?.[localVarOperationServerIndex]?.url;
@@ -602,13 +605,13 @@ export const BudgetApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Returns a list of all options, with their investment context and NPV.
+         * Returns a list of all options, with their investment context and NPV. If value_framework_id is omitted, NPV will be null for all options.
          * @summary List all options available to be added to a budget
-         * @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 listAvailableOptions(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetOptionResponse>>> {
+        async listAvailableOptions(valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BudgetOptionResponse>>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableOptions(valueFrameworkId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['BudgetApi.listAvailableOptions']?.[localVarOperationServerIndex]?.url;
@@ -684,22 +687,22 @@ export const BudgetApiFactory = function (configuration?: Configuration, basePat
          * Return all distinct investments that have at least one option linked to this budget. Each row shows the investment\'s current preferred option data and a flag indicating whether the preferred option is the one linked to the budget. NPV is computed for the preferred option from the v_option_npv view.
          * @summary List investments linked to this budget via options
          * @param {string} budgetId UUID of the budget
-         * @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}
          */
-        getBudgetInvestments(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetInvestmentResponse>> {
+        getBudgetInvestments(budgetId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetInvestmentResponse>> {
             return localVarFp.getBudgetInvestments(budgetId, valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
          * Return all options linked to this budget. Rows are ordered by investment name then option name. NPV is computed from the v_option_npv view for the given value framework.
          * @summary List options linked to this budget
          * @param {string} budgetId UUID of the budget
-         * @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}
          */
-        getBudgetOptions(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetOptionResponse>> {
+        getBudgetOptions(budgetId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetOptionResponse>> {
             return localVarFp.getBudgetOptions(budgetId, valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
@@ -735,13 +738,13 @@ export const BudgetApiFactory = function (configuration?: Configuration, basePat
             return localVarFp.linkOptionsToBudget(budgetId, budgetLinkOptionsRequest, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of all options, with their investment context and NPV.
+         * Returns a list of all options, with their investment context and NPV. If value_framework_id is omitted, NPV will be null for all options.
          * @summary List all options available to be added to a budget
-         * @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}
          */
-        listAvailableOptions(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetOptionResponse>> {
+        listAvailableOptions(valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetOptionResponse>> {
             return localVarFp.listAvailableOptions(valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
@@ -809,11 +812,11 @@ export class BudgetApi extends BaseAPI {
      * Return all distinct investments that have at least one option linked to this budget. Each row shows the investment\'s current preferred option data and a flag indicating whether the preferred option is the one linked to the budget. NPV is computed for the preferred option from the v_option_npv view.
      * @summary List investments linked to this budget via options
      * @param {string} budgetId UUID of the budget
-     * @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 getBudgetInvestments(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+    public getBudgetInvestments(budgetId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
         return BudgetApiFp(this.configuration).getBudgetInvestments(budgetId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
 
@@ -821,11 +824,11 @@ export class BudgetApi extends BaseAPI {
      * Return all options linked to this budget. Rows are ordered by investment name then option name. NPV is computed from the v_option_npv view for the given value framework.
      * @summary List options linked to this budget
      * @param {string} budgetId UUID of the budget
-     * @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 getBudgetOptions(budgetId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+    public getBudgetOptions(budgetId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
         return BudgetApiFp(this.configuration).getBudgetOptions(budgetId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
 
@@ -865,13 +868,13 @@ export class BudgetApi extends BaseAPI {
     }
 
     /**
-     * Returns a list of all options, with their investment context and NPV.
+     * Returns a list of all options, with their investment context and NPV. If value_framework_id is omitted, NPV will be null for all options.
      * @summary List all options available to be added to a budget
-     * @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 listAvailableOptions(valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+    public listAvailableOptions(valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
         return BudgetApiFp(this.configuration).listAvailableOptions(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
 

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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -163,25 +163,22 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
             };
         },
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
          * @summary Get the kpis for a given option inside a value framework
          * @param {string} optionId UUID of the option
          * @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}
          */
-        getOptionKpis: async (optionId: string, investmentId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getOptionKpis: async (optionId: string, investmentId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'optionId' is not null or undefined
             assertParamExists('getOptionKpis', 'optionId', optionId)
             // verify required parameter 'investmentId' is not null or undefined
             assertParamExists('getOptionKpis', 'investmentId', investmentId)
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            assertParamExists('getOptionKpis', 'valueFrameworkId', valueFrameworkId)
-            const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
+            const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis`
                 .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
-                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
-                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -197,6 +194,10 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
             // oauth required
             await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
 
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
             localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -400,15 +401,15 @@ export const OptionApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
          * @summary Get the kpis for a given option inside a value framework
          * @param {string} optionId UUID of the option
          * @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 getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
+        async getOptionKpis(optionId: string, investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionKpis(optionId, investmentId, valueFrameworkId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['OptionApi.getOptionKpis']?.[localVarOperationServerIndex]?.url;
@@ -501,15 +502,15 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
             return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
         },
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
+         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
          * @summary Get the kpis for a given option inside a value framework
          * @param {string} optionId UUID of the option
          * @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}
          */
-        getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
+        getOptionKpis(optionId: string, investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
             return localVarFp.getOptionKpis(optionId, investmentId, valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
@@ -591,15 +592,15 @@ export class OptionApi extends BaseAPI {
     }
 
     /**
-     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view.
+     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework. Data is sourced from the v_option_yearly_kpis database view. If no value_framework_id is provided, returns an empty list.
      * @summary Get the kpis for a given option inside a value framework
      * @param {string} optionId UUID of the option
      * @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 getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+    public getOptionKpis(optionId: string, investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
         return OptionApiFp(this.configuration).getOptionKpis(optionId, 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * 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-dev4
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).