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

package/dist/esm/api/option-api.js

@@ -311,7 +311,7 @@ export const OptionApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * 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.
          * @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
@@ -392,6 +392,45 @@ export const OptionApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+         * @summary Option overview table for this investment
+         * @param {string} investmentId UUID of the investment
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionsOverview: (investmentId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [investmentId_1, valueFrameworkId_1, ...args_1], void 0, function* (investmentId, valueFrameworkId, options = {}) {
+            // verify required parameter 'investmentId' is not null or undefined
+            assertParamExists('getOptionsOverview', 'investmentId', investmentId);
+            // verify required parameter 'valueFrameworkId' is not null or undefined
+            assertParamExists('getOptionsOverview', 'valueFrameworkId', valueFrameworkId);
+            const localVarPath = `/investment/{investment_id}/option/overview`
+                .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;
+            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 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 = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * 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
@@ -613,7 +652,7 @@ export const OptionApiFp = function (configuration) {
             });
         },
         /**
-         * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+         * 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.
          * @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
@@ -648,6 +687,23 @@ export const OptionApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+         * @summary Option overview table for this investment
+         * @param {string} investmentId UUID of the investment
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionsOverview(investmentId, valueFrameworkId, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionsOverview(investmentId, valueFrameworkId, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OptionApi.getOptionsOverview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * 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
@@ -776,7 +832,7 @@ export const OptionApiFactory = function (configuration, basePath, axios) {
             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
+         * 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.
          * @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
@@ -799,6 +855,17 @@ export const OptionApiFactory = function (configuration, basePath, axios) {
         getOptionsForInvestment(investmentId, offset, limit, options) {
             return localVarFp.getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+         * @summary Option overview table for this investment
+         * @param {string} investmentId UUID of the investment
+         * @param {string} valueFrameworkId UUID of the value framework
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getOptionsOverview(investmentId, valueFrameworkId, options) {
+            return localVarFp.getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(axios, basePath));
+        },
         /**
          * 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
@@ -913,7 +980,7 @@ 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
+     * 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.
      * @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
@@ -936,6 +1003,17 @@ export class OptionApi extends BaseAPI {
     getOptionsForInvestment(investmentId, offset, limit, options) {
         return OptionApiFp(this.configuration).getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+     * @summary Option overview table for this investment
+     * @param {string} investmentId UUID of the investment
+     * @param {string} valueFrameworkId UUID of the value framework
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOptionsOverview(investmentId, valueFrameworkId, options) {
+        return OptionApiFp(this.configuration).getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * 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

package/dist/esm/models/index.d.ts

@@ -4,6 +4,7 @@ export * from './impact-apiresponse';
 export * from './impact-create';
 export * from './impact-update';
 export * from './investment-create';
+export * from './investment-overview-response';
 export * from './investment-response';
 export * from './investment-update';
 export * from './location-inner';
@@ -24,6 +25,7 @@ export * from './objective-weight-update';
 export * from './option-chart-kpi';
 export * from './option-chart-kpis-yearly';
 export * from './option-create';
+export * from './option-overview-response';
 export * from './option-response';
 export * from './option-update';
 export * from './preferred-option-request';

package/dist/esm/models/index.js

@@ -4,6 +4,7 @@ export * from './impact-apiresponse';
 export * from './impact-create';
 export * from './impact-update';
 export * from './investment-create';
+export * from './investment-overview-response';
 export * from './investment-response';
 export * from './investment-update';
 export * from './location-inner';
@@ -24,6 +25,7 @@ export * from './objective-weight-update';
 export * from './option-chart-kpi';
 export * from './option-chart-kpis-yearly';
 export * from './option-create';
+export * from './option-overview-response';
 export * from './option-response';
 export * from './option-update';
 export * from './preferred-option-request';

package/dist/esm/models/investment-overview-response.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema for the investment overview table — one row per investment.
+ */
+export interface InvestmentOverviewResponse {
+    /**
+     * ID of the investment
+     */
+    'investment_id': string;
+    /**
+     * Name of the investment
+     */
+    'investment_name': string;
+    'preferred_option_cost'?: number | null;
+    'preferred_option_duration'?: number | null;
+    'preferred_option_name'?: string | null;
+    'preferred_option_npv'?: number | null;
+    'preferred_option_start_date'?: string | null;
+}

package/dist/esm/models/investment-overview-response.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/esm/models/option-overview-response.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema for the option overview table — one row per option within an investment.
+ */
+export interface OptionOverviewResponse {
+    /**
+     * Cost of the option
+     */
+    'cost': number;
+    /**
+     * Duration of the option in weeks
+     */
+    'duration': number;
+    'npv'?: number | null;
+    /**
+     * ID of the option
+     */
+    'option_id': string;
+    /**
+     * Name of the option
+     */
+    'option_name': string;
+    /**
+     * Expected start date of the option (ISO 8601)
+     */
+    'start_date': string;
+}

package/dist/esm/models/option-overview-response.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export {};

package/dist/models/index.d.ts

@@ -4,6 +4,7 @@ export * from './impact-apiresponse';
 export * from './impact-create';
 export * from './impact-update';
 export * from './investment-create';
+export * from './investment-overview-response';
 export * from './investment-response';
 export * from './investment-update';
 export * from './location-inner';
@@ -24,6 +25,7 @@ export * from './objective-weight-update';
 export * from './option-chart-kpi';
 export * from './option-chart-kpis-yearly';
 export * from './option-create';
+export * from './option-overview-response';
 export * from './option-response';
 export * from './option-update';
 export * from './preferred-option-request';

package/dist/models/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./impact-apiresponse"), exports);
 __exportStar(require("./impact-create"), exports);
 __exportStar(require("./impact-update"), exports);
 __exportStar(require("./investment-create"), exports);
+__exportStar(require("./investment-overview-response"), exports);
 __exportStar(require("./investment-response"), exports);
 __exportStar(require("./investment-update"), exports);
 __exportStar(require("./location-inner"), exports);
@@ -40,6 +41,7 @@ __exportStar(require("./objective-weight-update"), exports);
 __exportStar(require("./option-chart-kpi"), exports);
 __exportStar(require("./option-chart-kpis-yearly"), exports);
 __exportStar(require("./option-create"), exports);
+__exportStar(require("./option-overview-response"), exports);
 __exportStar(require("./option-response"), exports);
 __exportStar(require("./option-update"), exports);
 __exportStar(require("./preferred-option-request"), exports);

package/dist/models/investment-overview-response.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema for the investment overview table — one row per investment.
+ */
+export interface InvestmentOverviewResponse {
+    /**
+     * ID of the investment
+     */
+    'investment_id': string;
+    /**
+     * Name of the investment
+     */
+    'investment_name': string;
+    'preferred_option_cost'?: number | null;
+    'preferred_option_duration'?: number | null;
+    'preferred_option_name'?: string | null;
+    'preferred_option_npv'?: number | null;
+    'preferred_option_start_date'?: string | null;
+}

package/dist/models/investment-overview-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/option-overview-response.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Schema for the option overview table — one row per option within an investment.
+ */
+export interface OptionOverviewResponse {
+    /**
+     * Cost of the option
+     */
+    'cost': number;
+    /**
+     * Duration of the option in weeks
+     */
+    'duration': number;
+    'npv'?: number | null;
+    /**
+     * ID of the option
+     */
+    'option_id': string;
+    /**
+     * Name of the option
+     */
+    'option_name': string;
+    /**
+     * Expected start date of the option (ISO 8601)
+     */
+    'start_date': string;
+}

package/dist/models/option-overview-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.2.0-dev6
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/docs/InvestmentApi.md

@@ -13,9 +13,11 @@ All URIs are relative to *http://localhost*
 |[**getImpactsForOption**](#getimpactsforoption) | **GET** /investment/{investment_id}/option/{option_id}/impact/ | List impacts for this option|
 |[**getInvestmentById**](#getinvestmentbyid) | **GET** /investment/{investment_id} | Get an investment by ID|
 |[**getInvestments**](#getinvestments) | **GET** /investment/ | List investments|
+|[**getInvestmentsOverview**](#getinvestmentsoverview) | **GET** /investment/overview | Investment overview table|
 |[**getOptionForInvestment**](#getoptionforinvestment) | **GET** /investment/{investment_id}/option/{option_id} | Get an option for this investment|
 |[**getOptionKpis**](#getoptionkpis) | **GET** /investment/{investment_id}/option/{option_id}/kpis/{value_framework_id} | Get the kpis for a given option inside a value framework|
 |[**getOptionsForInvestment**](#getoptionsforinvestment) | **GET** /investment/{investment_id}/option/ | List options for this investment|
+|[**getOptionsOverview**](#getoptionsoverview) | **GET** /investment/{investment_id}/option/overview | Option overview table for this investment|
 |[**getPreferredOption**](#getpreferredoption) | **GET** /investment/{investment_id}/preferred_option | Get the preferred option for an investment|
 |[**patchImpactForOption**](#patchimpactforoption) | **PATCH** /investment/{investment_id}/option/{option_id}/impact/{impact_id} | Partially update an impact for this option|
 |[**patchInvestment**](#patchinvestment) | **PATCH** /investment/{investment_id} | Partially update an investment|
@@ -530,6 +532,58 @@ const { status, data } = await apiInstance.getInvestments(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getInvestmentsOverview**
+> Array<InvestmentOverviewResponse> getInvestmentsOverview()
+
+Return a flat overview of all investments. For each investment the preferred option\'s name, start date, cost, duration and NPV (computed by the v_option_npv database view for the given value framework) are included. Investments without a preferred option have null values for those fields.
+
+### Example
+
+```typescript
+import {
+    InvestmentApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new InvestmentApi(configuration);
+
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getInvestmentsOverview(
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<InvestmentOverviewResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Overview list of all investments |  -  |
+|**404** | Value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getOptionForInvestment**
 > OptionResponse getOptionForInvestment()
 
@@ -588,7 +642,7 @@ const { status, data } = await apiInstance.getOptionForInvestment(
 # **getOptionKpis**
 > Array<OptionChartKPIsYearly> getOptionKpis()
 
-Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
+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.
 
 ### Example
 
@@ -639,7 +693,7 @@ const { status, data } = await apiInstance.getOptionKpis(
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | The requested KPIs |  -  |
-|**404** | Investment, option or value framework not found |  -  |
+|**404** | Investment, option, value framework, or phase not found |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -701,6 +755,61 @@ const { status, data } = await apiInstance.getOptionsForInvestment(
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getOptionsOverview**
+> Array<OptionOverviewResponse> getOptionsOverview()
+
+Return a flat overview of all options for a specific investment. Each row includes the option\'s start date, cost, duration and NPV computed by the v_option_npv database view for the given value framework.
+
+### Example
+
+```typescript
+import {
+    InvestmentApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new InvestmentApi(configuration);
+
+let investmentId: string; //UUID of the investment (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getOptionsOverview(
+    investmentId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **investmentId** | [**string**] | UUID of the investment | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<OptionOverviewResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Overview list of all options for the investment |  -  |
+|**404** | Investment or value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getPreferredOption**
 > PreferredOptionResponse getPreferredOption()
 

package/docs/InvestmentOverviewResponse.md

@@ -0,0 +1,33 @@
+# InvestmentOverviewResponse
+
+Schema for the investment overview table — one row per investment.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**investmentId** | **string** | ID of the investment | [default to undefined]
+**investmentName** | **string** | Name of the investment | [default to undefined]
+**preferredOptionCost** | **number** |  | [optional] [default to undefined]
+**preferredOptionDuration** | **number** |  | [optional] [default to undefined]
+**preferredOptionName** | **string** |  | [optional] [default to undefined]
+**preferredOptionNpv** | **number** |  | [optional] [default to undefined]
+**preferredOptionStartDate** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvestmentOverviewResponse } from '@cosmotech/aip-client';
+
+const instance: InvestmentOverviewResponse = {
+    investmentId,
+    investmentName,
+    preferredOptionCost,
+    preferredOptionDuration,
+    preferredOptionName,
+    preferredOptionNpv,
+    preferredOptionStartDate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)