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

package/api/option-api.ts

@@ -4,7 +4,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).
@@ -28,6 +28,8 @@ import type { ImpactCreate } from '../models';
 // @ts-ignore
 import type { ImpactUpdate } from '../models';
 // @ts-ignore
+import type { OptionChartKPIsYearly } from '../models';
+// @ts-ignore
 import type { OptionCreate } from '../models';
 // @ts-ignore
 import type { OptionResponse } from '../models';
@@ -354,6 +356,52 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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: async (investmentId: string, optionId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'investmentId' is not null or undefined
+            assertParamExists('getOptionKpis', 'investmentId', investmentId)
+            // verify required parameter 'optionId' is not null or undefined
+            assertParamExists('getOptionKpis', 'optionId', optionId)
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getOptionKpis', 'valueFrameworkId', valueFrameworkId)
+            const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis/{value_framework_id}`
+                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
+                .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
+                .replace(`{${"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,
+            };
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -612,6 +660,21 @@ export const OptionApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OptionApi.getOptionForInvestment']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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}
+         */
+        async getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionKpis(investmentId, optionId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OptionApi.getOptionKpis']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -749,6 +812,18 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
         getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse> {
             return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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>> {
+            return localVarFp.getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieve a paginated list of all options for a specific investment.
          * @summary List options for this investment
@@ -882,6 +957,19 @@ export class OptionApi extends BaseAPI {
         return OptionApiFp(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 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}
+     */
+    public getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+        return OptionApiFp(this.configuration).getOptionKpis(investmentId, optionId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Retrieve a paginated list of all options for a specific investment.
      * @summary List options for this investment

package/api/{favored-option-api.ts → preferred-option-api.ts}

@@ -4,7 +4,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).
@@ -22,13 +22,13 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
 // @ts-ignore
-import type { FavoredOptionRequest } from '../models';
+import type { PreferredOptionRequest } from '../models';
 // @ts-ignore
-import type { FavoredOptionResponse } from '../models';
+import type { PreferredOptionResponse } from '../models';
 /**
- * FavoredOptionApi - axios parameter creator
+ * PreferredOptionApi - axios parameter creator
  */
-export const FavoredOptionApiAxiosParamCreator = function (configuration?: Configuration) {
+export const PreferredOptionApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
          * Get the preferred option for an investment.
@@ -37,10 +37,10 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Confi
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getFavoredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getPreferredOption: async (investmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'investmentId' is not null or undefined
-            assertParamExists('getFavoredOption', 'investmentId', investmentId)
-            const localVarPath = `/investment/{investment_id}/favored_option`
+            assertParamExists('getPreferredOption', 'investmentId', investmentId)
+            const localVarPath = `/investment/{investment_id}/preferred_option`
                 .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -72,16 +72,16 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Confi
          * 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: async (investmentId: string, favoredOptionRequest: FavoredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        setPreferredOption: async (investmentId: string, preferredOptionRequest: PreferredOptionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'investmentId' is not null or undefined
-            assertParamExists('setFavoredOption', 'investmentId', investmentId)
-            // verify required parameter 'favoredOptionRequest' is not null or undefined
-            assertParamExists('setFavoredOption', 'favoredOptionRequest', favoredOptionRequest)
-            const localVarPath = `/investment/{investment_id}/favored_option`
+            assertParamExists('setPreferredOption', 'investmentId', investmentId)
+            // verify required parameter 'preferredOptionRequest' is not null or undefined
+            assertParamExists('setPreferredOption', 'preferredOptionRequest', preferredOptionRequest)
+            const localVarPath = `/investment/{investment_id}/preferred_option`
                 .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -104,7 +104,7 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Confi
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(favoredOptionRequest, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(preferredOptionRequest, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -115,10 +115,10 @@ export const FavoredOptionApiAxiosParamCreator = function (configuration?: Confi
 };
 
 /**
- * FavoredOptionApi - functional programming interface
+ * PreferredOptionApi - functional programming interface
  */
-export const FavoredOptionApiFp = function(configuration?: Configuration) {
-    const localVarAxiosParamCreator = FavoredOptionApiAxiosParamCreator(configuration)
+export const PreferredOptionApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = PreferredOptionApiAxiosParamCreator(configuration)
     return {
         /**
          * Get the preferred option for an investment.
@@ -127,34 +127,34 @@ export const FavoredOptionApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getFavoredOption(investmentId, options);
+        async getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPreferredOption(investmentId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
-            const localVarOperationServerBasePath = operationServerMap['FavoredOptionApi.getFavoredOption']?.[localVarOperationServerIndex]?.url;
+            const localVarOperationServerBasePath = operationServerMap['PreferredOptionApi.getPreferredOption']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
          * 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}
          */
-        async setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FavoredOptionResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.setFavoredOption(investmentId, favoredOptionRequest, options);
+        async setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.setPreferredOption(investmentId, preferredOptionRequest, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
-            const localVarOperationServerBasePath = operationServerMap['FavoredOptionApi.setFavoredOption']?.[localVarOperationServerIndex]?.url;
+            const localVarOperationServerBasePath = operationServerMap['PreferredOptionApi.setPreferredOption']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
     }
 };
 
 /**
- * FavoredOptionApi - factory interface
+ * PreferredOptionApi - factory interface
  */
-export const FavoredOptionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
-    const localVarFp = FavoredOptionApiFp(configuration)
+export const PreferredOptionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = PreferredOptionApiFp(configuration)
     return {
         /**
          * Get the preferred option for an investment.
@@ -163,27 +163,27 @@ export const FavoredOptionApiFactory = function (configuration?: Configuration,
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<FavoredOptionResponse> {
-            return localVarFp.getFavoredOption(investmentId, options).then((request) => request(axios, basePath));
+        getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse> {
+            return localVarFp.getPreferredOption(investmentId, options).then((request) => request(axios, basePath));
         },
         /**
          * 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> {
-            return localVarFp.setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(axios, basePath));
+        setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse> {
+            return localVarFp.setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(axios, basePath));
         },
     };
 };
 
 /**
- * FavoredOptionApi - object-oriented interface
+ * PreferredOptionApi - object-oriented interface
  */
-export class FavoredOptionApi extends BaseAPI {
+export class PreferredOptionApi extends BaseAPI {
     /**
      * Get the preferred option for an investment.
      * @summary Get the preferred option for an investment
@@ -191,20 +191,20 @@ export class FavoredOptionApi extends BaseAPI {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public getFavoredOption(investmentId: string, options?: RawAxiosRequestConfig) {
-        return FavoredOptionApiFp(this.configuration).getFavoredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
+    public getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig) {
+        return PreferredOptionApiFp(this.configuration).getPreferredOption(investmentId, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
      * 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}
      */
-    public setFavoredOption(investmentId: string, favoredOptionRequest: FavoredOptionRequest, options?: RawAxiosRequestConfig) {
-        return FavoredOptionApiFp(this.configuration).setFavoredOption(investmentId, favoredOptionRequest, options).then((request) => request(this.axios, this.basePath));
+    public setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig) {
+        return PreferredOptionApiFp(this.configuration).setPreferredOption(investmentId, preferredOptionRequest, options).then((request) => request(this.axios, this.basePath));
     }
 }
 

package/api/value-framework-api.ts

@@ -4,7 +4,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).

package/api/value-framework-costs-api.ts

@@ -4,7 +4,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).

package/api/value-framework-weights-api.ts

@@ -4,7 +4,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).

package/api.ts

@@ -4,7 +4,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).
@@ -15,7 +15,6 @@
 
 
 export * from './api/default-api';
-export * from './api/favored-option-api';
 export * from './api/impact-api';
 export * from './api/investment-api';
 export * from './api/metric-api';
@@ -25,6 +24,7 @@ export * from './api/objective-api';
 export * from './api/objective-weight-api';
 export * from './api/objective-weights-api';
 export * from './api/option-api';
+export * from './api/preferred-option-api';
 export * from './api/value-framework-api';
 export * from './api/value-framework-costs-api';
 export * from './api/value-framework-weights-api';

package/base.ts

@@ -4,7 +4,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).

package/common.ts

@@ -4,7 +4,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).

package/configuration.ts

@@ -3,7 +3,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).

package/dist/api/default-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).

package/dist/api/default-api.js

@@ -5,7 +5,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).

package/dist/api/impact-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).

package/dist/api/impact-api.js

@@ -5,7 +5,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).