@cosmotech/aip-client 0.3.0-dev3 → 0.4.0-dev2

package/README.md

@@ -1,4 +1,4 @@
-## @cosmotech/aip-client@0.3.0-dev3
+## @cosmotech/aip-client@0.4.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.3.0-dev3 --save
+npm install @cosmotech/aip-client@0.4.0-dev2 --save
 ```
 
 _unPublished (not recommended):_
@@ -51,14 +51,15 @@ All URIs are relative to *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*BudgetApi* | [**bulkDeleteBudgets**](docs/BudgetApi.md#bulkdeletebudgets) | **DELETE** /budget/bulk | Bulk delete budgets
+*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
@@ -104,6 +105,28 @@ Class | Method | HTTP request | Description
 *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
+*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* | [**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
+*PortfolioInvestmentApi* | [**addInvestmentToPortfolio**](docs/PortfolioInvestmentApi.md#addinvestmenttoportfolio) | **POST** /portfolio/{portfolio_id}/investment/{investment_id} | Add an investment to this portfolio
+*PortfolioInvestmentApi* | [**bulkAddInvestmentsToPortfolio**](docs/PortfolioInvestmentApi.md#bulkaddinvestmentstoportfolio) | **POST** /portfolio/{portfolio_id}/investment/bulk | Bulk add investments to this portfolio
+*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* | [**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* | [**getPortfolioBudgetExpenditure**](docs/PortfolioKPIApi.md#getportfoliobudgetexpenditure) | **GET** /portfolio/{portfolio_id}/budget-expenditure/{budget_id} | Budget year-by-year expenditure
+*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* | [**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
 *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
@@ -143,9 +166,13 @@ Class | Method | HTTP request | Description
  - [MetricCostsPerYearResponse](docs/MetricCostsPerYearResponse.md)
  - [MetricCostsPerYearUpdate](docs/MetricCostsPerYearUpdate.md)
  - [MetricCreate](docs/MetricCreate.md)
+ - [MetricPerformanceResponse](docs/MetricPerformanceResponse.md)
+ - [MetricPerformanceYear](docs/MetricPerformanceYear.md)
  - [MetricResponse](docs/MetricResponse.md)
  - [MetricType](docs/MetricType.md)
  - [MetricUpdate](docs/MetricUpdate.md)
+ - [MonetizedImpactResponse](docs/MonetizedImpactResponse.md)
+ - [MonetizedImpactYear](docs/MonetizedImpactYear.md)
  - [ObjectiveCreate](docs/ObjectiveCreate.md)
  - [ObjectiveResponse](docs/ObjectiveResponse.md)
  - [ObjectiveUpdate](docs/ObjectiveUpdate.md)
@@ -158,6 +185,24 @@ Class | Method | HTTP request | Description
  - [OptionOverviewResponse](docs/OptionOverviewResponse.md)
  - [OptionResponse](docs/OptionResponse.md)
  - [OptionUpdate](docs/OptionUpdate.md)
+ - [PortfolioBudgetExpenditureResponse](docs/PortfolioBudgetExpenditureResponse.md)
+ - [PortfolioBudgetExpenditureYear](docs/PortfolioBudgetExpenditureYear.md)
+ - [PortfolioBudgetUsageItem](docs/PortfolioBudgetUsageItem.md)
+ - [PortfolioBulkDeleteRequest](docs/PortfolioBulkDeleteRequest.md)
+ - [PortfolioCreate](docs/PortfolioCreate.md)
+ - [PortfolioInvestmentBulkAddRequest](docs/PortfolioInvestmentBulkAddRequest.md)
+ - [PortfolioInvestmentBulkAddResponse](docs/PortfolioInvestmentBulkAddResponse.md)
+ - [PortfolioInvestmentBulkDeleteRequest](docs/PortfolioInvestmentBulkDeleteRequest.md)
+ - [PortfolioInvestmentResponse](docs/PortfolioInvestmentResponse.md)
+ - [PortfolioKPIDistributionBudgetItem](docs/PortfolioKPIDistributionBudgetItem.md)
+ - [PortfolioKPIDistributionResponse](docs/PortfolioKPIDistributionResponse.md)
+ - [PortfolioKPIDistributionYearOverrun](docs/PortfolioKPIDistributionYearOverrun.md)
+ - [PortfolioKPIDistributionYearValue](docs/PortfolioKPIDistributionYearValue.md)
+ - [PortfolioKPIOverrunDistributionResponse](docs/PortfolioKPIOverrunDistributionResponse.md)
+ - [PortfolioKPIResponse](docs/PortfolioKPIResponse.md)
+ - [PortfolioOverviewItemResponse](docs/PortfolioOverviewItemResponse.md)
+ - [PortfolioResponse](docs/PortfolioResponse.md)
+ - [PortfolioUpdate](docs/PortfolioUpdate.md)
  - [PreferredOptionRequest](docs/PreferredOptionRequest.md)
  - [PreferredOptionResponse](docs/PreferredOptionResponse.md)
  - [ValidationError](docs/ValidationError.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -43,7 +43,7 @@ import type { BudgetUpdate } from '../models';
 export const BudgetApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+         * Delete multiple budgets by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no budgets are deleted. Options linked to deleted budgets will have their budget link removed (set to null).
          * @summary Bulk delete budgets
          * @param {BudgetBulkDeleteRequest} budgetBulkDeleteRequest 
          * @param {*} [options] Override http request option.
@@ -52,7 +52,7 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
         bulkDeleteBudgets: async (budgetBulkDeleteRequest: BudgetBulkDeleteRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'budgetBulkDeleteRequest' is not null or undefined
             assertParamExists('bulkDeleteBudgets', 'budgetBulkDeleteRequest', budgetBulkDeleteRequest)
-            const localVarPath = `/budget/bulk`;
+            const localVarPath = `/budget/bulk-delete`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -60,7 +60,7 @@ export const BudgetApiAxiosParamCreator = function (configuration?: Configuratio
                 baseOptions = configuration.baseOptions;
             }
 
-            const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
             const localVarHeaderParameter = {} as any;
             const localVarQueryParameter = {} as any;
 
@@ -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);
@@ -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
@@ -462,7 +494,7 @@ export const BudgetApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = BudgetApiAxiosParamCreator(configuration)
     return {
         /**
-         * Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+         * Delete multiple budgets by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no budgets are deleted. Options linked to deleted budgets will have their budget link removed (set to null).
          * @summary Bulk delete budgets
          * @param {BudgetBulkDeleteRequest} budgetBulkDeleteRequest 
          * @param {*} [options] Override http request option.
@@ -569,6 +601,19 @@ export const BudgetApiFp = function(configuration?: Configuration) {
             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
@@ -606,7 +651,7 @@ export const BudgetApiFactory = function (configuration?: Configuration, basePat
     const localVarFp = BudgetApiFp(configuration)
     return {
         /**
-         * Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+         * Delete multiple budgets by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no budgets are deleted. Options linked to deleted budgets will have their budget link removed (set to null).
          * @summary Bulk delete budgets
          * @param {BudgetBulkDeleteRequest} budgetBulkDeleteRequest 
          * @param {*} [options] Override http request option.
@@ -689,6 +734,16 @@ export const BudgetApiFactory = function (configuration?: Configuration, basePat
         linkOptionsToBudget(budgetId: string, budgetLinkOptionsRequest: BudgetLinkOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>> {
             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
@@ -718,7 +773,7 @@ export const BudgetApiFactory = function (configuration?: Configuration, basePat
  */
 export class BudgetApi extends BaseAPI {
     /**
-     * Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+     * Delete multiple budgets by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no budgets are deleted. Options linked to deleted budgets will have their budget link removed (set to null).
      * @summary Bulk delete budgets
      * @param {BudgetBulkDeleteRequest} budgetBulkDeleteRequest 
      * @param {*} [options] Override http request option.
@@ -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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -82,19 +82,19 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
         /**
          * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
          * @summary Delete an option for this investment
-         * @param {string} optionId UUID of the option
          * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        deleteOptionForInvestment: async (optionId: string, investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'optionId' is not null or undefined
-            assertParamExists('deleteOptionForInvestment', 'optionId', optionId)
+        deleteOptionForInvestment: async (investmentId: string, optionId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'investmentId' is not null or undefined
             assertParamExists('deleteOptionForInvestment', 'investmentId', investmentId)
+            // verify required parameter 'optionId' is not null or undefined
+            assertParamExists('deleteOptionForInvestment', 'optionId', optionId)
             const localVarPath = `/investment/{investment_id}/option/{option_id}`
-                .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
-                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
+                .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -165,22 +165,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.
          * @summary Get the kpis for a given option inside a value framework
-         * @param {string} investmentId UUID of the investment
          * @param {string} optionId UUID of the option
+         * @param {string} investmentId UUID of the investment
          * @param {string} valueFrameworkId UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOptionKpis: async (investmentId: string, optionId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'investmentId' is not null or undefined
-            assertParamExists('getOptionKpis', 'investmentId', investmentId)
+        getOptionKpis: async (optionId: string, investmentId: string, valueFrameworkId: string, 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}`
-                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
                 .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
                 .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);
@@ -374,13 +374,13 @@ export const OptionApiFp = function(configuration?: Configuration) {
         /**
          * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
          * @summary Delete an option for this investment
-         * @param {string} optionId UUID of the option
          * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOptionForInvestment(optionId, investmentId, options);
+        async deleteOptionForInvestment(investmentId: string, optionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.deleteOptionForInvestment(investmentId, optionId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['OptionApi.deleteOptionForInvestment']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -402,14 +402,14 @@ export const OptionApiFp = function(configuration?: Configuration) {
         /**
          * 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.
          * @summary Get the kpis for a given option inside a value framework
-         * @param {string} investmentId UUID of the investment
          * @param {string} optionId UUID of the option
+         * @param {string} investmentId UUID of the investment
          * @param {string} valueFrameworkId UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionKpis(investmentId, optionId, valueFrameworkId, options);
+        async getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, 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;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -481,13 +481,13 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
         /**
          * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
          * @summary Delete an option for this investment
-         * @param {string} optionId UUID of the option
          * @param {string} investmentId UUID of the investment
+         * @param {string} optionId UUID of the option
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
-            return localVarFp.deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
+        deleteOptionForInvestment(investmentId: string, optionId: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.deleteOptionForInvestment(investmentId, optionId, options).then((request) => request(axios, basePath));
         },
         /**
          * Retrieve a specific option for the investment.
@@ -503,14 +503,14 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
         /**
          * 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.
          * @summary Get the kpis for a given option inside a value framework
-         * @param {string} investmentId UUID of the investment
          * @param {string} optionId UUID of the option
+         * @param {string} investmentId UUID of the investment
          * @param {string} valueFrameworkId UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
-            return localVarFp.getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
+            return localVarFp.getOptionKpis(optionId, investmentId, valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
          * Retrieve a paginated list of all options for a specific investment.
@@ -569,13 +569,13 @@ export class OptionApi extends BaseAPI {
     /**
      * Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
      * @summary Delete an option for this investment
-     * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
+     * @param {string} optionId UUID of the option
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig) {
-        return OptionApiFp(this.configuration).deleteOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
+    public deleteOptionForInvestment(investmentId: string, optionId: string, options?: RawAxiosRequestConfig) {
+        return OptionApiFp(this.configuration).deleteOptionForInvestment(investmentId, optionId, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -593,14 +593,14 @@ 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.
      * @summary Get the kpis for a given option inside a value framework
-     * @param {string} investmentId UUID of the investment
      * @param {string} optionId UUID of the option
+     * @param {string} investmentId UUID of the investment
      * @param {string} valueFrameworkId UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
-        return OptionApiFp(this.configuration).getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    public getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return OptionApiFp(this.configuration).getOptionKpis(optionId, investmentId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**