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

package/README.md

@@ -1,4 +1,4 @@
-## @cosmotech/aip-client@0.4.0-dev1
+## @cosmotech/aip-client@0.4.0-dev4
 
 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-dev1 --save
+npm install @cosmotech/aip-client@0.4.0-dev4 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,11 +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 | 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* | [**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* | [**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* | [**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
@@ -107,7 +108,7 @@ Class | Method | HTTP request | Description
 *PortfolioApi* | [**bulkDeletePortfolios**](docs/PortfolioApi.md#bulkdeleteportfolios) | **POST** /portfolio/bulk-delete | Bulk delete portfolios
 *PortfolioApi* | [**deletePortfolio**](docs/PortfolioApi.md#deleteportfolio) | **DELETE** /portfolio/{portfolio_id} | Delete a portfolio
 *PortfolioApi* | [**getPortfolioById**](docs/PortfolioApi.md#getportfoliobyid) | **GET** /portfolio/{portfolio_id} | Get a portfolio by ID
-*PortfolioApi* | [**getPortfolioOverview**](docs/PortfolioApi.md#getportfoliooverview) | **GET** /portfolio/overview/{value_framework_id} | Portfolio overview with KPIs
+*PortfolioApi* | [**getPortfolioOverview**](docs/PortfolioApi.md#getportfoliooverview) | **GET** /portfolio/overview | Portfolio overview with KPIs
 *PortfolioApi* | [**getPortfolios**](docs/PortfolioApi.md#getportfolios) | **GET** /portfolio/ | List portfolios
 *PortfolioApi* | [**patchPortfolio**](docs/PortfolioApi.md#patchportfolio) | **PATCH** /portfolio/{portfolio_id} | Partially update a portfolio
 *PortfolioApi* | [**postPortfolio**](docs/PortfolioApi.md#postportfolio) | **POST** /portfolio/ | Create a portfolio
@@ -116,16 +117,20 @@ Class | Method | HTTP request | Description
 *PortfolioInvestmentApi* | [**bulkRemoveInvestmentsFromPortfolio**](docs/PortfolioInvestmentApi.md#bulkremoveinvestmentsfromportfolio) | **POST** /portfolio/{portfolio_id}/investment/bulk-delete | Bulk remove investments from this portfolio
 *PortfolioInvestmentApi* | [**getInvestmentForPortfolio**](docs/PortfolioInvestmentApi.md#getinvestmentforportfolio) | **GET** /portfolio/{portfolio_id}/investment/{investment_id} | Get an investment link in this portfolio
 *PortfolioInvestmentApi* | [**getInvestmentsForPortfolio**](docs/PortfolioInvestmentApi.md#getinvestmentsforportfolio) | **GET** /portfolio/{portfolio_id}/investment/ | List investments in this portfolio
+*PortfolioInvestmentApi* | [**getPortfolioInvestmentsOverview**](docs/PortfolioInvestmentApi.md#getportfolioinvestmentsoverview) | **GET** /portfolio/{portfolio_id}/investment/overview | Investment overview table for this portfolio
 *PortfolioInvestmentApi* | [**removeInvestmentFromPortfolio**](docs/PortfolioInvestmentApi.md#removeinvestmentfromportfolio) | **DELETE** /portfolio/{portfolio_id}/investment/{investment_id} | Remove an investment from this portfolio
-*PortfolioKPIApi* | [**getCapexDistribution**](docs/PortfolioKPIApi.md#getcapexdistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/capex-distribution | CAPEX year-by-year distribution
-*PortfolioKPIApi* | [**getInvestmentsDistribution**](docs/PortfolioKPIApi.md#getinvestmentsdistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/investments-distribution | Investment count year-by-year distribution
-*PortfolioKPIApi* | [**getKpiOverrunDistribution**](docs/PortfolioKPIApi.md#getkpioverrundistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/overrun-distribution | Budget overrun year-by-year distribution
-*PortfolioKPIApi* | [**getNpvDistribution**](docs/PortfolioKPIApi.md#getnpvdistribution) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id}/npv-distribution | NPV year-by-year distribution
+*PortfolioKPIApi* | [**getCapexDistribution**](docs/PortfolioKPIApi.md#getcapexdistribution) | **GET** /portfolio/{portfolio_id}/kpis/capex-distribution | CAPEX year-by-year distribution
+*PortfolioKPIApi* | [**getInvestmentsDistribution**](docs/PortfolioKPIApi.md#getinvestmentsdistribution) | **GET** /portfolio/{portfolio_id}/kpis/investments-distribution | Investment count year-by-year distribution
+*PortfolioKPIApi* | [**getKpiOverrunDistribution**](docs/PortfolioKPIApi.md#getkpioverrundistribution) | **GET** /portfolio/{portfolio_id}/kpis/overrun-distribution | Budget overrun year-by-year distribution
+*PortfolioKPIApi* | [**getNpvDistribution**](docs/PortfolioKPIApi.md#getnpvdistribution) | **GET** /portfolio/{portfolio_id}/kpis/npv-distribution | NPV year-by-year distribution
 *PortfolioKPIApi* | [**getPortfolioBudgetExpenditure**](docs/PortfolioKPIApi.md#getportfoliobudgetexpenditure) | **GET** /portfolio/{portfolio_id}/budget-expenditure/{budget_id} | Budget year-by-year expenditure
+*PortfolioKPIApi* | [**getPortfolioBudgetExpenditureAll**](docs/PortfolioKPIApi.md#getportfoliobudgetexpenditureall) | **GET** /portfolio/{portfolio_id}/budget-expenditure-all | Budget year-by-year expenditure for all budgets
+*PortfolioKPIApi* | [**getPortfolioBudgetExpenditureNoBudget**](docs/PortfolioKPIApi.md#getportfoliobudgetexpenditurenobudget) | **GET** /portfolio/{portfolio_id}/budget-expenditure-no-budget | Year-by-year expenditure for options with no budget
 *PortfolioKPIApi* | [**getPortfolioBudgetUsage**](docs/PortfolioKPIApi.md#getportfoliobudgetusage) | **GET** /portfolio/{portfolio_id}/budget-usage | Budget usage summary
-*PortfolioKPIApi* | [**getPortfolioKpis**](docs/PortfolioKPIApi.md#getportfoliokpis) | **GET** /portfolio/{portfolio_id}/kpis/{value_framework_id} | Get portfolio KPIs
+*PortfolioKPIApi* | [**getPortfolioKpis**](docs/PortfolioKPIApi.md#getportfoliokpis) | **GET** /portfolio/{portfolio_id}/kpis | Get portfolio KPIs
 *PortfolioKPIApi* | [**getPortfolioMetricPerformance**](docs/PortfolioKPIApi.md#getportfoliometricperformance) | **GET** /portfolio/{portfolio_id}/metric-performance/{metric_id} | Metric performance over time
-*PortfolioKPIApi* | [**getPortfolioMonetizedImpact**](docs/PortfolioKPIApi.md#getportfoliomonetizedimpact) | **GET** /portfolio/{portfolio_id}/monetized-impact/{value_framework_id} | Portfolio monetized impact over time
+*PortfolioKPIApi* | [**getPortfolioMonetizedImpact**](docs/PortfolioKPIApi.md#getportfoliomonetizedimpact) | **GET** /portfolio/{portfolio_id}/monetized-impact | Portfolio monetized impact over time
+*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
 *ValueFrameworkApi* | [**deleteValueFramework**](docs/ValueFrameworkApi.md#deletevalueframework) | **DELETE** /value_framework/{value_framework_id} | Delete a value framework
@@ -170,6 +175,9 @@ Class | Method | HTTP request | Description
  - [MetricResponse](docs/MetricResponse.md)
  - [MetricType](docs/MetricType.md)
  - [MetricUpdate](docs/MetricUpdate.md)
+ - [MonetizedImpactDetailedResponse](docs/MonetizedImpactDetailedResponse.md)
+ - [MonetizedImpactDetailedYear](docs/MonetizedImpactDetailedYear.md)
+ - [MonetizedImpactMetricValue](docs/MonetizedImpactMetricValue.md)
  - [MonetizedImpactResponse](docs/MonetizedImpactResponse.md)
  - [MonetizedImpactYear](docs/MonetizedImpactYear.md)
  - [ObjectiveCreate](docs/ObjectiveCreate.md)
@@ -192,6 +200,7 @@ Class | Method | HTTP request | Description
  - [PortfolioInvestmentBulkAddRequest](docs/PortfolioInvestmentBulkAddRequest.md)
  - [PortfolioInvestmentBulkAddResponse](docs/PortfolioInvestmentBulkAddResponse.md)
  - [PortfolioInvestmentBulkDeleteRequest](docs/PortfolioInvestmentBulkDeleteRequest.md)
+ - [PortfolioInvestmentOverviewResponse](docs/PortfolioInvestmentOverviewResponse.md)
  - [PortfolioInvestmentResponse](docs/PortfolioInvestmentResponse.md)
  - [PortfolioKPIDistributionBudgetItem](docs/PortfolioKPIDistributionBudgetItem.md)
  - [PortfolioKPIDistributionResponse](docs/PortfolioKPIDistributionResponse.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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -168,8 +168,9 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
             assertParamExists('getBudgetInvestments', 'budgetId', budgetId)
             // verify required parameter 'valueFrameworkId' is not null or undefined
             assertParamExists('getBudgetInvestments', 'valueFrameworkId', valueFrameworkId)
-            const localVarPath = `/budget/{budget_id}/investments`
-                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
+            const localVarPath = `/budget/{budget_id}/investments/{value_framework_id}`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)))
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -185,10 +186,6 @@ 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);
@@ -213,8 +210,9 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
             assertParamExists('getBudgetOptions', 'budgetId', budgetId)
             // verify required parameter 'valueFrameworkId' is not null or undefined
             assertParamExists('getBudgetOptions', 'valueFrameworkId', valueFrameworkId)
-            const localVarPath = `/budget/{budget_id}/options`
-                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)));
+            const localVarPath = `/budget/{budget_id}/options/{value_framework_id}`
+                .replace(`{${"budget_id"}}`, encodeURIComponent(String(budgetId)))
+                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -230,10 +228,6 @@ 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);
@@ -328,7 +322,7 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
             };
         },
         /**
-         * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+         * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Also any previous option linked to this budget will be overwritten. Returns the list of option IDs that were successfully linked.
          * @summary Bulk-link options to this budget
          * @param {string} budgetId UUID of the budget
          * @param {BudgetLinkOptionsRequest} budgetLinkOptionsRequest 
@@ -370,6 +364,44 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Returns a list of all options, with their investment context and NPV.
+         * @summary List all options available to be added to a budget
+         * @param {string} 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)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update one or more fields of an existing budget. Only the fields included in the request body will be modified; omitted fields remain unchanged.
          * @summary Partially update a budget
@@ -556,19 +588,32 @@ export const BudgetApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+         * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Also any previous option linked to this budget will be overwritten. Returns the list of option IDs that were successfully linked.
          * @summary Bulk-link options to this budget
          * @param {string} budgetId UUID of the budget
          * @param {BudgetLinkOptionsRequest} budgetLinkOptionsRequest 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>> {
+        async linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string | null>>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.linkOptionsToBudget(budgetId, budgetLinkOptionsRequest, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['BudgetApi.linkOptionsToBudget']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Returns a list of all options, with their investment context and NPV.
+         * @summary List all options available to be added to a budget
+         * @param {string} 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>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableOptions(valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BudgetApi.listAvailableOptions']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Update one or more fields of an existing budget. Only the fields included in the request body will be modified; omitted fields remain unchanged.
          * @summary Partially update a budget
@@ -679,16 +724,26 @@ export const BudgetApiFactory = function (configuration?: Configuration, basePat
             return localVarFp.getBudgets(offset, limit, options).then((request) => request(axios, basePath));
         },
         /**
-         * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+         * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Also any previous option linked to this budget will be overwritten. Returns the list of option IDs that were successfully linked.
          * @summary Bulk-link options to this budget
          * @param {string} budgetId UUID of the budget
          * @param {BudgetLinkOptionsRequest} budgetLinkOptionsRequest 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
+        linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string | null>> {
             return localVarFp.linkOptionsToBudget(budgetId, budgetLinkOptionsRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Returns a list of all options, with their investment context and NPV.
+         * @summary List all options available to be added to a budget
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listAvailableOptions(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<BudgetOptionResponse>> {
+            return localVarFp.listAvailableOptions(valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update one or more fields of an existing budget. Only the fields included in the request body will be modified; omitted fields remain unchanged.
          * @summary Partially update a budget
@@ -798,7 +853,7 @@ export class BudgetApi extends BaseAPI {
     }
 
     /**
-     * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+     * Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Also any previous option linked to this budget will be overwritten. Returns the list of option IDs that were successfully linked.
      * @summary Bulk-link options to this budget
      * @param {string} budgetId UUID of the budget
      * @param {BudgetLinkOptionsRequest} budgetLinkOptionsRequest 
@@ -809,6 +864,17 @@ export class BudgetApi extends BaseAPI {
         return BudgetApiFp(this.configuration).linkOptionsToBudget(budgetId, budgetLinkOptionsRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Returns a list of all options, with their investment context and NPV.
+     * @summary List all options available to be added to a budget
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public listAvailableOptions(valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return BudgetApiFp(this.configuration).listAvailableOptions(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Update one or more fields of an existing budget. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update a budget

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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * 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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * 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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -194,15 +194,13 @@ export const InvestmentApiAxiosParamCreator = function (configuration?: Configur
             };
         },
         /**
-         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
          * @summary Investment overview table
-         * @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}
          */
-        getInvestmentsOverview: async (valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            assertParamExists('getInvestmentsOverview', 'valueFrameworkId', valueFrameworkId)
+        getInvestmentsOverview: async (valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/investment/overview`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -379,13 +377,13 @@ export const InvestmentApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
          * @summary Investment overview table
-         * @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 getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentOverviewResponse>>> {
+        async getInvestmentsOverview(valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentOverviewResponse>>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getInvestmentsOverview(valueFrameworkId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['InvestmentApi.getInvestmentsOverview']?.[localVarOperationServerIndex]?.url;
@@ -469,13 +467,13 @@ export const InvestmentApiFactory = function (configuration?: Configuration, bas
             return localVarFp.getInvestments(offset, limit, options).then((request) => request(axios, basePath));
         },
         /**
-         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+         * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
          * @summary Investment overview table
-         * @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}
          */
-        getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentOverviewResponse>> {
+        getInvestmentsOverview(valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentOverviewResponse>> {
             return localVarFp.getInvestmentsOverview(valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
@@ -552,13 +550,13 @@ export class InvestmentApi extends BaseAPI {
     }
 
     /**
-     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields. When no value_framework_id is provided, NPV is returned as null.
      * @summary Investment overview table
-     * @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 getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+    public getInvestmentsOverview(valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
         return InvestmentApiFp(this.configuration).getInvestmentsOverview(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
 

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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * 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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * 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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * 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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * 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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * 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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * 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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -150,19 +150,16 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
             };
         },
         /**
-         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
          * @summary Portfolio overview with KPIs
-         * @param {string} valueFrameworkId UUID of the value framework
          * @param {number} [offset] Number of records to skip
          * @param {number} [limit] Max number of records to return
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPortfolioOverview: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            assertParamExists('getPortfolioOverview', 'valueFrameworkId', valueFrameworkId)
-            const localVarPath = `/portfolio/overview/{value_framework_id}`
-                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+        getPortfolioOverview: async (offset?: number, limit?: number, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/portfolio/overview`;
             // 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 PortfolioApiAxiosParamCreator = function (configuration?: Configura
                 localVarQueryParameter['limit'] = limit;
             }
 
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
             localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -372,16 +373,16 @@ export const PortfolioApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
          * @summary Portfolio overview with KPIs
-         * @param {string} valueFrameworkId UUID of the value framework
          * @param {number} [offset] Number of records to skip
          * @param {number} [limit] Max number of records to return
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioOverviewItemResponse>>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioOverview(valueFrameworkId, offset, limit, options);
+        async getPortfolioOverview(offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioOverviewItemResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioOverview(offset, limit, valueFrameworkId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['PortfolioApi.getPortfolioOverview']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -467,16 +468,16 @@ export const PortfolioApiFactory = function (configuration?: Configuration, base
             return localVarFp.getPortfolioById(portfolioId, options).then((request) => request(axios, basePath));
         },
         /**
-         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
          * @summary Portfolio overview with KPIs
-         * @param {string} valueFrameworkId UUID of the value framework
          * @param {number} [offset] Number of records to skip
          * @param {number} [limit] Max number of records to return
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioOverviewItemResponse>> {
-            return localVarFp.getPortfolioOverview(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
+        getPortfolioOverview(offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioOverviewItemResponse>> {
+            return localVarFp.getPortfolioOverview(offset, limit, valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
          * Retrieve a paginated list of all portfolios.
@@ -551,16 +552,16 @@ export class PortfolioApi extends BaseAPI {
     }
 
     /**
-     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
      * @summary Portfolio overview with KPIs
-     * @param {string} valueFrameworkId UUID of the value framework
      * @param {number} [offset] Number of records to skip
      * @param {number} [limit] Max number of records to return
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
-        return PortfolioApiFp(this.configuration).getPortfolioOverview(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
+    public getPortfolioOverview(offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
+        return PortfolioApiFp(this.configuration).getPortfolioOverview(offset, limit, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**