@cosmotech/aip-client 0.4.0-dev2 → 0.4.0-dev5

package/api/option-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -163,25 +163,22 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
             };
         },
         /**
-         * 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.
+         * 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. If no value_framework_id is provided, returns an empty list.
          * @summary Get the kpis for a given option inside a value framework
          * @param {string} optionId UUID of the option
          * @param {string} investmentId UUID of the investment
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOptionKpis: async (optionId: string, investmentId: string, valueFrameworkId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getOptionKpis: async (optionId: string, investmentId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'optionId' is not null or undefined
             assertParamExists('getOptionKpis', 'optionId', optionId)
             // verify required parameter 'investmentId' is not null or undefined
             assertParamExists('getOptionKpis', 'investmentId', investmentId)
-            // 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}`
+            const localVarPath = `/investment/{investment_id}/option/{option_id}/kpis`
                 .replace(`{${"option_id"}}`, encodeURIComponent(String(optionId)))
-                .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)))
-                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+                .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);
             let baseOptions;
@@ -197,6 +194,10 @@ export const OptionApiAxiosParamCreator = function (configuration?: Configuratio
             // oauth required
             await setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration)
 
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
             localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -400,15 +401,15 @@ export const OptionApiFp = function(configuration?: Configuration) {
             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. Data is sourced from the v_option_yearly_kpis database view.
+         * 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. If no value_framework_id is provided, returns an empty list.
          * @summary Get the kpis for a given option inside a value framework
          * @param {string} optionId UUID of the option
          * @param {string} investmentId UUID of the investment
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
+        async getOptionKpis(optionId: string, investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionKpis(optionId, investmentId, valueFrameworkId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['OptionApi.getOptionKpis']?.[localVarOperationServerIndex]?.url;
@@ -501,15 +502,15 @@ export const OptionApiFactory = function (configuration?: Configuration, basePat
             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. Data is sourced from the v_option_yearly_kpis database view.
+         * 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. If no value_framework_id is provided, returns an empty list.
          * @summary Get the kpis for a given option inside a value framework
          * @param {string} optionId UUID of the option
          * @param {string} investmentId UUID of the investment
-         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
+        getOptionKpis(optionId: string, investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>> {
             return localVarFp.getOptionKpis(optionId, investmentId, valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
@@ -591,15 +592,15 @@ export class OptionApi extends BaseAPI {
     }
 
     /**
-     * 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.
+     * 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. If no value_framework_id is provided, returns an empty list.
      * @summary Get the kpis for a given option inside a value framework
      * @param {string} optionId UUID of the option
      * @param {string} investmentId UUID of the investment
-     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public getOptionKpis(optionId: string, investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) {
+    public getOptionKpis(optionId: string, investmentId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
         return OptionApiFp(this.configuration).getOptionKpis(optionId, investmentId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
 

package/api/portfolio-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -150,19 +150,16 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
             };
         },
         /**
-         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
          * @summary Portfolio overview with KPIs
-         * @param {string} valueFrameworkId UUID of the value framework
          * @param {number} [offset] Number of records to skip
          * @param {number} [limit] Max number of records to return
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPortfolioOverview: async (valueFrameworkId: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            assertParamExists('getPortfolioOverview', 'valueFrameworkId', valueFrameworkId)
-            const localVarPath = `/portfolio/overview/{value_framework_id}`
-                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+        getPortfolioOverview: async (offset?: number, limit?: number, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/portfolio/overview`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -186,6 +183,10 @@ export const PortfolioApiAxiosParamCreator = function (configuration?: Configura
                 localVarQueryParameter['limit'] = limit;
             }
 
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
             localVarHeaderParameter['Accept'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -372,16 +373,16 @@ export const PortfolioApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
          * @summary Portfolio overview with KPIs
-         * @param {string} valueFrameworkId UUID of the value framework
          * @param {number} [offset] Number of records to skip
          * @param {number} [limit] Max number of records to return
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioOverviewItemResponse>>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioOverview(valueFrameworkId, offset, limit, options);
+        async getPortfolioOverview(offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioOverviewItemResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioOverview(offset, limit, valueFrameworkId, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['PortfolioApi.getPortfolioOverview']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -467,16 +468,16 @@ export const PortfolioApiFactory = function (configuration?: Configuration, base
             return localVarFp.getPortfolioById(portfolioId, options).then((request) => request(axios, basePath));
         },
         /**
-         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+         * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
          * @summary Portfolio overview with KPIs
-         * @param {string} valueFrameworkId UUID of the value framework
          * @param {number} [offset] Number of records to skip
          * @param {number} [limit] Max number of records to return
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioOverviewItemResponse>> {
-            return localVarFp.getPortfolioOverview(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
+        getPortfolioOverview(offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioOverviewItemResponse>> {
+            return localVarFp.getPortfolioOverview(offset, limit, valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
          * Retrieve a paginated list of all portfolios.
@@ -551,16 +552,16 @@ export class PortfolioApi extends BaseAPI {
     }
 
     /**
-     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The value framework is used to compute NPV.
+     * Return the full list of portfolios enriched with their KPIs (nb_investments, total_cost, date range, budget_overrun, NPV). The optional value_framework_id query parameter is used to compute NPV; when omitted, NPV fields are null.
      * @summary Portfolio overview with KPIs
-     * @param {string} valueFrameworkId UUID of the value framework
      * @param {number} [offset] Number of records to skip
      * @param {number} [limit] Max number of records to return
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public getPortfolioOverview(valueFrameworkId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
-        return PortfolioApiFp(this.configuration).getPortfolioOverview(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
+    public getPortfolioOverview(offset?: number, limit?: number, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
+        return PortfolioApiFp(this.configuration).getPortfolioOverview(offset, limit, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/api/portfolio-investment-api.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev2
+ * The version of the OpenAPI document: 0.4.0-dev5
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,6 +28,8 @@ import type { PortfolioInvestmentBulkAddResponse } from '../models';
 // @ts-ignore
 import type { PortfolioInvestmentBulkDeleteRequest } from '../models';
 // @ts-ignore
+import type { PortfolioInvestmentOverviewResponse } from '../models';
+// @ts-ignore
 import type { PortfolioInvestmentResponse } from '../models';
 /**
  * PortfolioInvestmentApi - axios parameter creator
@@ -251,6 +253,49 @@ export const PortfolioInvestmentApiAxiosParamCreator = function (configuration?:
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Return a flat overview of all investments in this portfolio. For each investment the preferred option\'s name, start date, cost, duration, NPV and budget name are included. Investments without a preferred option have null values for those fields.
+         * @summary Investment overview table for this portfolio
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioInvestmentsOverview: async (portfolioId: string, valueFrameworkId?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'portfolioId' is not null or undefined
+            assertParamExists('getPortfolioInvestmentsOverview', 'portfolioId', portfolioId)
+            const localVarPath = `/portfolio/{portfolio_id}/investment/overview`
+                .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)
+
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+
+            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,
+            };
+        },
         /**
          * Remove an investment from this portfolio by deleting the link.
          * @summary Remove an investment from this portfolio
@@ -372,6 +417,20 @@ export const PortfolioInvestmentApiFp = function(configuration?: Configuration)
             const localVarOperationServerBasePath = operationServerMap['PortfolioInvestmentApi.getInvestmentsForPortfolio']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Return a flat overview of all investments in this portfolio. For each investment the preferred option\'s name, start date, cost, duration, NPV and budget name are included. Investments without a preferred option have null values for those fields.
+         * @summary Investment overview table for this portfolio
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getPortfolioInvestmentsOverview(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioInvestmentOverviewResponse>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getPortfolioInvestmentsOverview(portfolioId, valueFrameworkId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['PortfolioInvestmentApi.getPortfolioInvestmentsOverview']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Remove an investment from this portfolio by deleting the link.
          * @summary Remove an investment from this portfolio
@@ -451,6 +510,17 @@ export const PortfolioInvestmentApiFactory = function (configuration?: Configura
         getInvestmentsForPortfolio(portfolioId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioInvestmentResponse>> {
             return localVarFp.getInvestmentsForPortfolio(portfolioId, offset, limit, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Return a flat overview of all investments in this portfolio. For each investment the preferred option\'s name, start date, cost, duration, NPV and budget name are included. Investments without a preferred option have null values for those fields.
+         * @summary Investment overview table for this portfolio
+         * @param {string} portfolioId UUID of the portfolio
+         * @param {string | null} [valueFrameworkId] UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPortfolioInvestmentsOverview(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioInvestmentOverviewResponse>> {
+            return localVarFp.getPortfolioInvestmentsOverview(portfolioId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Remove an investment from this portfolio by deleting the link.
          * @summary Remove an investment from this portfolio
@@ -530,6 +600,18 @@ export class PortfolioInvestmentApi extends BaseAPI {
         return PortfolioInvestmentApiFp(this.configuration).getInvestmentsForPortfolio(portfolioId, offset, limit, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Return a flat overview of all investments in this portfolio. For each investment the preferred option\'s name, start date, cost, duration, NPV and budget name are included. Investments without a preferred option have null values for those fields.
+     * @summary Investment overview table for this portfolio
+     * @param {string} portfolioId UUID of the portfolio
+     * @param {string | null} [valueFrameworkId] UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getPortfolioInvestmentsOverview(portfolioId: string, valueFrameworkId?: string | null, options?: RawAxiosRequestConfig) {
+        return PortfolioInvestmentApiFp(this.configuration).getPortfolioInvestmentsOverview(portfolioId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Remove an investment from this portfolio by deleting the link.
      * @summary Remove an investment from this portfolio