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

package/api/portfolio-kpiapi.ts

@@ -0,0 +1,772 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { MetricPerformanceResponse } from '../models';
+// @ts-ignore
+import type { MonetizedImpactResponse } from '../models';
+// @ts-ignore
+import type { PortfolioBudgetExpenditureResponse } from '../models';
+// @ts-ignore
+import type { PortfolioBudgetUsageItem } from '../models';
+// @ts-ignore
+import type { PortfolioKPIDistributionResponse } from '../models';
+// @ts-ignore
+import type { PortfolioKPIOverrunDistributionResponse } from '../models';
+// @ts-ignore
+import type { PortfolioKPIResponse } from '../models';
+/**
+ * PortfolioKPIApi - axios parameter creator
+ */
+export const PortfolioKPIApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Total cost of preferred options starting each year.
+         * @summary CAPEX year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCapexDistribution: async (portfolioId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getCapexDistribution', 'portfolioId', portfolioId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getCapexDistribution', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/capex-distribution`
+                .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
+                .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,
+            };
+        },
+        /**
+         * Count of investments with a preferred option starting each year.
+         * @summary Investment count year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInvestmentsDistribution: async (portfolioId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getInvestmentsDistribution', 'portfolioId', portfolioId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getInvestmentsDistribution', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/investments-distribution`
+                .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
+                .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,
+            };
+        },
+        /**
+         * Break down budget overruns by year across all preferred options in the portfolio.  For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
+         * @summary Budget overrun year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getKpiOverrunDistribution: async (portfolioId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getKpiOverrunDistribution', 'portfolioId', portfolioId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getKpiOverrunDistribution', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/overrun-distribution`
+                .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
+                .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,
+            };
+        },
+        /**
+         * Sum of final NPV of preferred options starting each year.
+         * @summary NPV year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNpvDistribution: async (portfolioId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getNpvDistribution', 'portfolioId', portfolioId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getNpvDistribution', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}/npv-distribution`
+                .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
+                .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,
+            };
+        },
+        /**
+         * Return year-by-year expenditure of preferred options linked to a specific budget within this portfolio.
+         * @summary Budget year-by-year expenditure
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} budgetId UUID of the budget
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioBudgetExpenditure: async (portfolioId: string, budgetId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getPortfolioBudgetExpenditure', 'portfolioId', portfolioId)
+            // verify required parameter 'budgetId' is not null or undefined
+            assertParamExists('getPortfolioBudgetExpenditure', 'budgetId', budgetId)
+            const localVarPath = `/portfolio/{portfolio_id}/budget-expenditure/{budget_id}`
+                .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
+                .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;
+            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,
+            };
+        },
+        /**
+         * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
+         * @summary Budget usage summary
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioBudgetUsage: async (portfolioId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getPortfolioBudgetUsage', 'portfolioId', portfolioId)
+            const localVarPath = `/portfolio/{portfolio_id}/budget-usage`
+                .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)));
+            // 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,
+            };
+        },
+        /**
+         * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
+         * @summary Get portfolio KPIs
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioKpis: async (portfolioId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getPortfolioKpis', 'portfolioId', portfolioId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getPortfolioKpis', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/portfolio/{portfolio_id}/kpis/{value_framework_id}`
+                .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
+                .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,
+            };
+        },
+        /**
+         * Return the year-by-year summed raw metric value across all preferred options in the portfolio for a given metric. The metric_value is framework-independent.
+         * @summary Metric performance over time
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} metricId UUID of the metric
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioMetricPerformance: async (portfolioId: string, metricId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getPortfolioMetricPerformance', 'portfolioId', portfolioId)
+            // verify required parameter 'metricId' is not null or undefined
+            assertParamExists('getPortfolioMetricPerformance', 'metricId', metricId)
+            const localVarPath = `/portfolio/{portfolio_id}/metric-performance/{metric_id}`
+                .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
+                .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)));
+            // 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,
+            };
+        },
+        /**
+         * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
+         * @summary Portfolio monetized impact over time
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioMonetizedImpact: async (portfolioId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getPortfolioMonetizedImpact', 'portfolioId', portfolioId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getPortfolioMonetizedImpact', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/portfolio/{portfolio_id}/monetized-impact/{value_framework_id}`
+                .replace(`{${"portfolio_id"}}`, encodeURIComponent(String(portfolioId)))
+                .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,
+            };
+        },
+    }
+};
+
+/**
+ * PortfolioKPIApi - functional programming interface
+ */
+export const PortfolioKPIApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = PortfolioKPIApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Total cost of preferred options starting each year.
+         * @summary CAPEX year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getCapexDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getCapexDistribution(portfolioId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getCapexDistribution']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Count of investments with a preferred option starting each year.
+         * @summary Investment count year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getInvestmentsDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getInvestmentsDistribution(portfolioId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getInvestmentsDistribution']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Break down budget overruns by year across all preferred options in the portfolio.  For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
+         * @summary Budget overrun year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getKpiOverrunDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIOverrunDistributionResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getKpiOverrunDistribution(portfolioId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getKpiOverrunDistribution']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Sum of final NPV of preferred options starting each year.
+         * @summary NPV year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getNpvDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getNpvDistribution(portfolioId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getNpvDistribution']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Return year-by-year expenditure of preferred options linked to a specific budget within this portfolio.
+         * @summary Budget year-by-year expenditure
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} budgetId UUID of the budget
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPortfolioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioBudgetExpenditureResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioBudgetExpenditure(portfolioId, budgetId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioBudgetExpenditure']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
+         * @summary Budget usage summary
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPortfolioBudgetUsage(portfolioId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioBudgetUsageItem>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioBudgetUsage(portfolioId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioBudgetUsage']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
+         * @summary Get portfolio KPIs
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPortfolioKpis(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioKpis(portfolioId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioKpis']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Return the year-by-year summed raw metric value across all preferred options in the portfolio for a given metric. The metric_value is framework-independent.
+         * @summary Metric performance over time
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} metricId UUID of the metric
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPortfolioMetricPerformance(portfolioId: string, metricId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricPerformanceResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioMetricPerformance(portfolioId, metricId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioMetricPerformance']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
+         * @summary Portfolio monetized impact over time
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MonetizedImpactResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioKPIApi.getPortfolioMonetizedImpact']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * PortfolioKPIApi - factory interface
+ */
+export const PortfolioKPIApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = PortfolioKPIApiFp(configuration)
+    return {
+        /**
+         * Total cost of preferred options starting each year.
+         * @summary CAPEX year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCapexDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse> {
+            return localVarFp.getCapexDistribution(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Count of investments with a preferred option starting each year.
+         * @summary Investment count year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getInvestmentsDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse> {
+            return localVarFp.getInvestmentsDistribution(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Break down budget overruns by year across all preferred options in the portfolio.  For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
+         * @summary Budget overrun year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getKpiOverrunDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIOverrunDistributionResponse> {
+            return localVarFp.getKpiOverrunDistribution(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Sum of final NPV of preferred options starting each year.
+         * @summary NPV year-by-year distribution
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNpvDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIDistributionResponse> {
+            return localVarFp.getNpvDistribution(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Return year-by-year expenditure of preferred options linked to a specific budget within this portfolio.
+         * @summary Budget year-by-year expenditure
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} budgetId UUID of the budget
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioBudgetExpenditureResponse> {
+            return localVarFp.getPortfolioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
+         * @summary Budget usage summary
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioBudgetUsage(portfolioId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioBudgetUsageItem>> {
+            return localVarFp.getPortfolioBudgetUsage(portfolioId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
+         * @summary Get portfolio KPIs
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioKpis(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<PortfolioKPIResponse> {
+            return localVarFp.getPortfolioKpis(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Return the year-by-year summed raw metric value across all preferred options in the portfolio for a given metric. The metric_value is framework-independent.
+         * @summary Metric performance over time
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} metricId UUID of the metric
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioMetricPerformance(portfolioId: string, metricId: string, options?: RawAxiosRequestConfig): AxiosPromise<MetricPerformanceResponse> {
+            return localVarFp.getPortfolioMetricPerformance(portfolioId, metricId, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
+         * @summary Portfolio monetized impact over time
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<MonetizedImpactResponse> {
+            return localVarFp.getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * PortfolioKPIApi - object-oriented interface
+ */
+export class PortfolioKPIApi extends BaseAPI {
+    /**
+     * Total cost of preferred options starting each year.
+     * @summary CAPEX year-by-year distribution
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getCapexDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return PortfolioKPIApiFp(this.configuration).getCapexDistribution(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Count of investments with a preferred option starting each year.
+     * @summary Investment count year-by-year distribution
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getInvestmentsDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return PortfolioKPIApiFp(this.configuration).getInvestmentsDistribution(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Break down budget overruns by year across all preferred options in the portfolio.  For each year, shows per-budget whether the annual expenditure exceeds the budget capacity.
+     * @summary Budget overrun year-by-year distribution
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getKpiOverrunDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return PortfolioKPIApiFp(this.configuration).getKpiOverrunDistribution(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Sum of final NPV of preferred options starting each year.
+     * @summary NPV year-by-year distribution
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getNpvDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return PortfolioKPIApiFp(this.configuration).getNpvDistribution(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Return year-by-year expenditure of preferred options linked to a specific budget within this portfolio.
+     * @summary Budget year-by-year expenditure
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} budgetId UUID of the budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getPortfolioBudgetExpenditure(portfolioId: string, budgetId: string, options?: RawAxiosRequestConfig) {
+        return PortfolioKPIApiFp(this.configuration).getPortfolioBudgetExpenditure(portfolioId, budgetId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * For each budget referenced by preferred options in this portfolio, return usage and overrun statistics.
+     * @summary Budget usage summary
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getPortfolioBudgetUsage(portfolioId: string, options?: RawAxiosRequestConfig) {
+        return PortfolioKPIApiFp(this.configuration).getPortfolioBudgetUsage(portfolioId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Return KPIs (nb_investments, total_cost, date range, budget_overrun, NPV) for the specified portfolio and value framework.
+     * @summary Get portfolio KPIs
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getPortfolioKpis(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return PortfolioKPIApiFp(this.configuration).getPortfolioKpis(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Return the year-by-year summed raw metric value across all preferred options in the portfolio for a given metric. The metric_value is framework-independent.
+     * @summary Metric performance over time
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} metricId UUID of the metric
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getPortfolioMetricPerformance(portfolioId: string, metricId: string, options?: RawAxiosRequestConfig) {
+        return PortfolioKPIApiFp(this.configuration).getPortfolioMetricPerformance(portfolioId, metricId, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Return year-by-year monetized impact (sum of all metric monetary values) and investment cost (preferred option CAPEX by start year) across the portfolio.
+     * @summary Portfolio monetized impact over time
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getPortfolioMonetizedImpact(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return PortfolioKPIApiFp(this.configuration).getPortfolioMonetizedImpact(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+