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

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-dev1
+ * The version of the OpenAPI document: 0.4.0-dev4
  * 
  *
  * 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