@cosmotech/aip-client 0.2.0-dev4 → 0.2.0-dev6

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,17 +12,18 @@
 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 { InvestmentResponse } from '../models';
 import type { InvestmentUpdate } from '../models';
+import type { OptionChartKPIsYearly } from '../models';
 import type { OptionCreate } 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
  */
@@ -73,14 +74,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
@@ -128,6 +121,16 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     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
+     * @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} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis: (investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -138,6 +141,14 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getOptionsForInvestment: (investmentId: string, offset?: number, limit?: number, 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
@@ -180,11 +191,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
@@ -236,14 +247,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
@@ -291,6 +294,16 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     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
+     * @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} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -301,6 +314,14 @@ 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>>>;
+    /**
+     * 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
@@ -343,11 +364,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
@@ -399,14 +420,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
@@ -454,6 +467,16 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     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
+     * @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} 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>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -464,6 +487,14 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>>;
+    /**
+     * 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
@@ -506,11 +537,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
@@ -562,14 +593,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
@@ -617,6 +640,16 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     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
+     * @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} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChartKPIsYearly[], any, {}>>;
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment
@@ -627,6 +660,14 @@ export declare class InvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse[], 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
@@ -669,9 +710,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, {}>>;
 }