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

package/dist/api/portfolio-api.js

@@ -5,7 +5,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-dev4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -133,19 +133,16 @@ const PortfolioApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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_1, offset_1, limit_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, offset_1, limit_1, ...args_1], void 0, function* (valueFrameworkId, offset, limit, options = {}) {
-            // verify required parameter 'valueFrameworkId' is not null or undefined
-            (0, common_1.assertParamExists)('getPortfolioOverview', 'valueFrameworkId', valueFrameworkId);
-            const localVarPath = `/portfolio/overview/{value_framework_id}`
-                .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
+        getPortfolioOverview: (offset_1, limit_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [offset_1, limit_1, valueFrameworkId_1, ...args_1], void 0, function* (offset, limit, valueFrameworkId, options = {}) {
+            const localVarPath = `/portfolio/overview`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -164,6 +161,9 @@ const PortfolioApiAxiosParamCreator = function (configuration) {
             if (limit !== undefined) {
                 localVarQueryParameter['limit'] = limit;
             }
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
             localVarHeaderParameter['Accept'] = 'application/json';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -340,18 +340,18 @@ const PortfolioApiFp = function (configuration) {
             });
         },
         /**
-         * 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, offset, limit, options) {
+        getPortfolioOverview(offset, limit, valueFrameworkId, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPortfolioOverview(valueFrameworkId, offset, limit, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPortfolioOverview(offset, limit, valueFrameworkId, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PortfolioApi.getPortfolioOverview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -447,16 +447,16 @@ const PortfolioApiFactory = function (configuration, basePath, axios) {
             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, offset, limit, options) {
-            return localVarFp.getPortfolioOverview(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
+        getPortfolioOverview(offset, limit, valueFrameworkId, options) {
+            return localVarFp.getPortfolioOverview(offset, limit, valueFrameworkId, options).then((request) => request(axios, basePath));
         },
         /**
          * Retrieve a paginated list of all portfolios.
@@ -528,16 +528,16 @@ class PortfolioApi extends base_1.BaseAPI {
         return (0, exports.PortfolioApiFp)(this.configuration).getPortfolioById(portfolioId, options).then((request) => request(this.axios, this.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, offset, limit, options) {
-        return (0, exports.PortfolioApiFp)(this.configuration).getPortfolioOverview(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
+    getPortfolioOverview(offset, limit, valueFrameworkId, options) {
+        return (0, exports.PortfolioApiFp)(this.configuration).getPortfolioOverview(offset, limit, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Retrieve a paginated list of all portfolios.

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

@@ -2,7 +2,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-dev4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../base';
 import type { PortfolioInvestmentBulkAddRequest } from '../models';
 import type { PortfolioInvestmentBulkAddResponse } from '../models';
 import type { PortfolioInvestmentBulkDeleteRequest } from '../models';
+import type { PortfolioInvestmentOverviewResponse } from '../models';
 import type { PortfolioInvestmentResponse } from '../models';
 /**
  * PortfolioInvestmentApi - axios parameter creator
@@ -66,6 +67,15 @@ export declare const PortfolioInvestmentApiAxiosParamCreator: (configuration?: C
      * @throws {RequiredError}
      */
     getInvestmentsForPortfolio: (portfolioId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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) => Promise<RequestArgs>;
     /**
      * Remove an investment from this portfolio by deleting the link.
      * @summary Remove an investment from this portfolio
@@ -126,6 +136,15 @@ export declare const PortfolioInvestmentApiFp: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     getInvestmentsForPortfolio(portfolioId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioInvestmentResponse>>>;
+    /**
+     * 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PortfolioInvestmentOverviewResponse>>>;
     /**
      * Remove an investment from this portfolio by deleting the link.
      * @summary Remove an investment from this portfolio
@@ -186,6 +205,15 @@ export declare const PortfolioInvestmentApiFactory: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getInvestmentsForPortfolio(portfolioId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<PortfolioInvestmentResponse>>;
+    /**
+     * 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>>;
     /**
      * Remove an investment from this portfolio by deleting the link.
      * @summary Remove an investment from this portfolio
@@ -246,6 +274,15 @@ export declare class PortfolioInvestmentApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getInvestmentsForPortfolio(portfolioId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PortfolioInvestmentResponse[], any, {}>>;
+    /**
+     * 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): Promise<import("axios").AxiosResponse<PortfolioInvestmentOverviewResponse[], any, {}>>;
     /**
      * Remove an investment from this portfolio by deleting the link.
      * @summary Remove an investment from this portfolio

package/dist/api/portfolio-investment-api.js

@@ -5,7 +5,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-dev4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -224,6 +224,43 @@ 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: (portfolioId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [portfolioId_1, valueFrameworkId_1, ...args_1], void 0, function* (portfolioId, valueFrameworkId, options = {}) {
+            // verify required parameter 'portfolioId' is not null or undefined
+            (0, common_1.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, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2AuthorizationCodeBearer required
+            // oauth required
+            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
+            if (valueFrameworkId !== undefined) {
+                localVarQueryParameter['value_framework_id'] = valueFrameworkId;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Remove an investment from this portfolio by deleting the link.
          * @summary Remove an investment from this portfolio
@@ -355,6 +392,23 @@ const PortfolioInvestmentApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.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}
+         */
+        getPortfolioInvestmentsOverview(portfolioId, valueFrameworkId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPortfolioInvestmentsOverview(portfolioId, valueFrameworkId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['PortfolioInvestmentApi.getPortfolioInvestmentsOverview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Remove an investment from this portfolio by deleting the link.
          * @summary Remove an investment from this portfolio
@@ -437,6 +491,17 @@ const PortfolioInvestmentApiFactory = function (configuration, basePath, axios)
         getInvestmentsForPortfolio(portfolioId, offset, limit, options) {
             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, valueFrameworkId, options) {
+            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
@@ -511,6 +576,17 @@ class PortfolioInvestmentApi extends base_1.BaseAPI {
     getInvestmentsForPortfolio(portfolioId, offset, limit, options) {
         return (0, exports.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}
+     */
+    getPortfolioInvestmentsOverview(portfolioId, valueFrameworkId, options) {
+        return (0, exports.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