@cosmotech/aip-client 0.2.0-dev5 → 0.2.0-dev7

package/dist/api/investment-api.d.ts

@@ -2,7 +2,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.2.0-dev3
+ * The version of the OpenAPI document: 0.2.0-dev6
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,18 +12,20 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
-import type { FavoredOptionRequest } from '../models';
-import type { FavoredOptionResponse } from '../models';
 import type { ImpactAPIResponse } from '../models';
 import type { ImpactCreate } from '../models';
 import type { ImpactUpdate } from '../models';
 import type { InvestmentCreate } from '../models';
+import type { InvestmentOverviewResponse } from '../models';
 import type { InvestmentResponse } from '../models';
 import type { InvestmentUpdate } from '../models';
 import type { OptionChartKPIsYearly } from '../models';
 import type { OptionCreate } from '../models';
+import type { OptionOverviewResponse } from '../models';
 import type { OptionResponse } from '../models';
 import type { OptionUpdate } from '../models';
+import type { PreferredOptionRequest } from '../models';
+import type { PreferredOptionResponse } from '../models';
 /**
  * InvestmentApi - axios parameter creator
  */
@@ -74,14 +76,6 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     deleteOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Get the preferred option for an investment.
-     * @summary Get the preferred option for an investment
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFavoredOption: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a specific impact for the option.
      * @summary Get an impact for this option
@@ -120,6 +114,14 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getInvestments: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * @summary Investment overview table
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvestmentsOverview: (valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -130,7 +132,7 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      */
     getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * 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
@@ -149,6 +151,23 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getOptionsForInvestment: (investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+     * @summary Option overview table for this investment
+     * @param {string} investmentId UUID of the investment
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionsOverview: (investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPreferredOption: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an impact for this option
@@ -191,11 +210,11 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * Set the preferred option for an investment.
      * @summary Set the preferred option for an investment
      * @param {string} investmentId UUID of the investment
-     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {PreferredOptionRequest} preferredOptionRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    setFavoredOption: (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    setPreferredOption: (investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * InvestmentApi - functional programming interface
@@ -247,14 +266,6 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Get the preferred option for an investment.
-     * @summary Get the preferred option for an investment
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
     /**
      * Retrieve a specific impact for the option.
      * @summary Get an impact for this option
@@ -293,6 +304,14 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentResponse>>>;
+    /**
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * @summary Investment overview table
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentOverviewResponse>>>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -303,7 +322,7 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
     /**
-     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * 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
@@ -322,6 +341,23 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionResponse>>>;
+    /**
+     * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+     * @summary Option overview table for this investment
+     * @param {string} investmentId UUID of the investment
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>>;
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>>;
     /**
      * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an impact for this option
@@ -364,11 +400,11 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * Set the preferred option for an investment.
      * @summary Set the preferred option for an investment
      * @param {string} investmentId UUID of the investment
-     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {PreferredOptionRequest} preferredOptionRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>>;
+    setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>>;
 };
 /**
  * InvestmentApi - factory interface
@@ -420,14 +456,6 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
-    /**
-     * Get the preferred option for an investment.
-     * @summary Get the preferred option for an investment
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
     /**
      * Retrieve a specific impact for the option.
      * @summary Get an impact for this option
@@ -466,6 +494,14 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentResponse>>;
+    /**
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * @summary Investment overview table
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentOverviewResponse>>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -476,7 +512,7 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
     /**
-     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * 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
@@ -495,6 +531,23 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>>;
+    /**
+     * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+     * @summary Option overview table for this investment
+     * @param {string} investmentId UUID of the investment
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>>;
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse>;
     /**
      * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an impact for this option
@@ -537,11 +590,11 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * Set the preferred option for an investment.
      * @summary Set the preferred option for an investment
      * @param {string} investmentId UUID of the investment
-     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {PreferredOptionRequest} preferredOptionRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse>;
+    setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse>;
 };
 /**
  * InvestmentApi - object-oriented interface
@@ -593,14 +646,6 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
-    /**
-     * Get the preferred option for an investment.
-     * @summary Get the preferred option for an investment
-     * @param {string} investmentId UUID of the investment
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
     /**
      * Retrieve a specific impact for the option.
      * @summary Get an impact for this option
@@ -639,6 +684,14 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse[], any, {}>>;
+    /**
+     * Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+     * @summary Investment overview table
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentOverviewResponse[], any, {}>>;
     /**
      * Retrieve a specific option for the investment.
      * @summary Get an option for this investment
@@ -649,7 +702,7 @@ export declare class InvestmentApi extends BaseAPI {
      */
     getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
     /**
-     * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+     * 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
@@ -668,6 +721,23 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse[], any, {}>>;
+    /**
+     * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+     * @summary Option overview table for this investment
+     * @param {string} investmentId UUID of the investment
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionOverviewResponse[], any, {}>>;
+    /**
+     * Get the preferred option for an investment.
+     * @summary Get the preferred option for an investment
+     * @param {string} investmentId UUID of the investment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferredOptionResponse, any, {}>>;
     /**
      * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
      * @summary Partially update an impact for this option
@@ -710,9 +780,9 @@ export declare class InvestmentApi extends BaseAPI {
      * Set the preferred option for an investment.
      * @summary Set the preferred option for an investment
      * @param {string} investmentId UUID of the investment
-     * @param {FavoredOptionRequest} favoredOptionRequest
+     * @param {PreferredOptionRequest} preferredOptionRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FavoredOptionResponse, any, {}>>;
+    setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferredOptionResponse, any, {}>>;
 }