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

package/dist/api/portfolio-kpiapi.d.ts

@@ -0,0 +1,361 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev2
+ *
+ *
+ * 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 { type RequestArgs, BaseAPI } from '../base';
+import type { MetricPerformanceResponse } from '../models';
+import type { MonetizedImpactResponse } from '../models';
+import type { PortfolioBudgetExpenditureResponse } from '../models';
+import type { PortfolioBudgetUsageItem } from '../models';
+import type { PortfolioKPIDistributionResponse } from '../models';
+import type { PortfolioKPIOverrunDistributionResponse } from '../models';
+import type { PortfolioKPIResponse } from '../models';
+/**
+ * PortfolioKPIApi - axios parameter creator
+ */
+export declare const PortfolioKPIApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
+};
+/**
+ * PortfolioKPIApi - functional programming interface
+ */
+export declare const PortfolioKPIApiFp: (configuration?: Configuration) => {
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIOverrunDistributionResponse>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIDistributionResponse>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioBudgetExpenditureResponse>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioBudgetUsageItem>>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioKPIResponse>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricPerformanceResponse>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MonetizedImpactResponse>>;
+};
+/**
+ * PortfolioKPIApi - factory interface
+ */
+export declare const PortfolioKPIApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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 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>;
+    /**
+     * 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 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 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 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>;
+};
+/**
+ * PortfolioKPIApi - object-oriented interface
+ */
+export declare 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}
+     */
+    getCapexDistribution(portfolioId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioKPIDistributionResponse, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<PortfolioKPIDistributionResponse, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<PortfolioKPIOverrunDistributionResponse, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<PortfolioKPIDistributionResponse, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<PortfolioBudgetExpenditureResponse, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<PortfolioBudgetUsageItem[], any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<PortfolioKPIResponse, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<MetricPerformanceResponse, any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<MonetizedImpactResponse, any, {}>>;
+}