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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -378,6 +378,41 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
378
378
  options: localVarRequestOptions,
379
379
  };
380
380
  }),
381
+ /**
382
+ * 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.
383
+ * @summary Investment overview table
384
+ * @param {string} valueFrameworkId UUID of the value framework
385
+ * @param {*} [options] Override http request option.
386
+ * @throws {RequiredError}
387
+ */
388
+ getInvestmentsOverview: (valueFrameworkId_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, ...args_1], void 0, function* (valueFrameworkId, options = {}) {
389
+ // verify required parameter 'valueFrameworkId' is not null or undefined
390
+ (0, common_1.assertParamExists)('getInvestmentsOverview', 'valueFrameworkId', valueFrameworkId);
391
+ const localVarPath = `/investment/overview`;
392
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
393
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
394
+ let baseOptions;
395
+ if (configuration) {
396
+ baseOptions = configuration.baseOptions;
397
+ }
398
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
399
+ const localVarHeaderParameter = {};
400
+ const localVarQueryParameter = {};
401
+ // authentication OAuth2AuthorizationCodeBearer required
402
+ // oauth required
403
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
404
+ if (valueFrameworkId !== undefined) {
405
+ localVarQueryParameter['value_framework_id'] = valueFrameworkId;
406
+ }
407
+ localVarHeaderParameter['Accept'] = 'application/json';
408
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
409
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
410
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
411
+ return {
412
+ url: (0, common_1.toPathString)(localVarUrlObj),
413
+ options: localVarRequestOptions,
414
+ };
415
+ }),
381
416
  /**
382
417
  * Retrieve a specific option for the investment.
383
418
  * @summary Get an option for this investment
@@ -416,7 +451,7 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
416
451
  };
417
452
  }),
418
453
  /**
419
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
454
+ * 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.
420
455
  * @summary Get the kpis for a given option inside a value framework
421
456
  * @param {string} investmentId UUID of the investment
422
457
  * @param {string} optionId UUID of the option
@@ -497,6 +532,45 @@ const InvestmentApiAxiosParamCreator = function (configuration) {
497
532
  options: localVarRequestOptions,
498
533
  };
499
534
  }),
535
+ /**
536
+ * 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.
537
+ * @summary Option overview table for this investment
538
+ * @param {string} investmentId UUID of the investment
539
+ * @param {string} valueFrameworkId UUID of the value framework
540
+ * @param {*} [options] Override http request option.
541
+ * @throws {RequiredError}
542
+ */
543
+ getOptionsOverview: (investmentId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [investmentId_1, valueFrameworkId_1, ...args_1], void 0, function* (investmentId, valueFrameworkId, options = {}) {
544
+ // verify required parameter 'investmentId' is not null or undefined
545
+ (0, common_1.assertParamExists)('getOptionsOverview', 'investmentId', investmentId);
546
+ // verify required parameter 'valueFrameworkId' is not null or undefined
547
+ (0, common_1.assertParamExists)('getOptionsOverview', 'valueFrameworkId', valueFrameworkId);
548
+ const localVarPath = `/investment/{investment_id}/option/overview`
549
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
550
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
551
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
552
+ let baseOptions;
553
+ if (configuration) {
554
+ baseOptions = configuration.baseOptions;
555
+ }
556
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
557
+ const localVarHeaderParameter = {};
558
+ const localVarQueryParameter = {};
559
+ // authentication OAuth2AuthorizationCodeBearer required
560
+ // oauth required
561
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
562
+ if (valueFrameworkId !== undefined) {
563
+ localVarQueryParameter['value_framework_id'] = valueFrameworkId;
564
+ }
565
+ localVarHeaderParameter['Accept'] = 'application/json';
566
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
567
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
568
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
569
+ return {
570
+ url: (0, common_1.toPathString)(localVarUrlObj),
571
+ options: localVarRequestOptions,
572
+ };
573
+ }),
500
574
  /**
501
575
  * Get the preferred option for an investment.
502
576
  * @summary Get the preferred option for an investment
@@ -893,6 +967,22 @@ const InvestmentApiFp = function (configuration) {
893
967
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
894
968
  });
895
969
  },
970
+ /**
971
+ * 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.
972
+ * @summary Investment overview table
973
+ * @param {string} valueFrameworkId UUID of the value framework
974
+ * @param {*} [options] Override http request option.
975
+ * @throws {RequiredError}
976
+ */
977
+ getInvestmentsOverview(valueFrameworkId, options) {
978
+ return __awaiter(this, void 0, void 0, function* () {
979
+ var _a, _b, _c;
980
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getInvestmentsOverview(valueFrameworkId, options);
981
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
982
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['InvestmentApi.getInvestmentsOverview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
983
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
984
+ });
985
+ },
896
986
  /**
897
987
  * Retrieve a specific option for the investment.
898
988
  * @summary Get an option for this investment
@@ -911,7 +1001,7 @@ const InvestmentApiFp = function (configuration) {
911
1001
  });
912
1002
  },
913
1003
  /**
914
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1004
+ * 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.
915
1005
  * @summary Get the kpis for a given option inside a value framework
916
1006
  * @param {string} investmentId UUID of the investment
917
1007
  * @param {string} optionId UUID of the option
@@ -946,6 +1036,23 @@ const InvestmentApiFp = function (configuration) {
946
1036
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
947
1037
  });
948
1038
  },
1039
+ /**
1040
+ * 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.
1041
+ * @summary Option overview table for this investment
1042
+ * @param {string} investmentId UUID of the investment
1043
+ * @param {string} valueFrameworkId UUID of the value framework
1044
+ * @param {*} [options] Override http request option.
1045
+ * @throws {RequiredError}
1046
+ */
1047
+ getOptionsOverview(investmentId, valueFrameworkId, options) {
1048
+ return __awaiter(this, void 0, void 0, function* () {
1049
+ var _a, _b, _c;
1050
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionsOverview(investmentId, valueFrameworkId, options);
1051
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1052
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['InvestmentApi.getOptionsOverview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1053
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1054
+ });
1055
+ },
949
1056
  /**
950
1057
  * Get the preferred option for an investment.
951
1058
  * @summary Get the preferred option for an investment
@@ -1160,6 +1267,16 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
1160
1267
  getInvestments(offset, limit, options) {
1161
1268
  return localVarFp.getInvestments(offset, limit, options).then((request) => request(axios, basePath));
1162
1269
  },
1270
+ /**
1271
+ * 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.
1272
+ * @summary Investment overview table
1273
+ * @param {string} valueFrameworkId UUID of the value framework
1274
+ * @param {*} [options] Override http request option.
1275
+ * @throws {RequiredError}
1276
+ */
1277
+ getInvestmentsOverview(valueFrameworkId, options) {
1278
+ return localVarFp.getInvestmentsOverview(valueFrameworkId, options).then((request) => request(axios, basePath));
1279
+ },
1163
1280
  /**
1164
1281
  * Retrieve a specific option for the investment.
1165
1282
  * @summary Get an option for this investment
@@ -1172,7 +1289,7 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
1172
1289
  return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
1173
1290
  },
1174
1291
  /**
1175
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1292
+ * 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.
1176
1293
  * @summary Get the kpis for a given option inside a value framework
1177
1294
  * @param {string} investmentId UUID of the investment
1178
1295
  * @param {string} optionId UUID of the option
@@ -1195,6 +1312,17 @@ const InvestmentApiFactory = function (configuration, basePath, axios) {
1195
1312
  getOptionsForInvestment(investmentId, offset, limit, options) {
1196
1313
  return localVarFp.getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(axios, basePath));
1197
1314
  },
1315
+ /**
1316
+ * 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.
1317
+ * @summary Option overview table for this investment
1318
+ * @param {string} investmentId UUID of the investment
1319
+ * @param {string} valueFrameworkId UUID of the value framework
1320
+ * @param {*} [options] Override http request option.
1321
+ * @throws {RequiredError}
1322
+ */
1323
+ getOptionsOverview(investmentId, valueFrameworkId, options) {
1324
+ return localVarFp.getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(axios, basePath));
1325
+ },
1198
1326
  /**
1199
1327
  * Get the preferred option for an investment.
1200
1328
  * @summary Get the preferred option for an investment
@@ -1371,6 +1499,16 @@ class InvestmentApi extends base_1.BaseAPI {
1371
1499
  getInvestments(offset, limit, options) {
1372
1500
  return (0, exports.InvestmentApiFp)(this.configuration).getInvestments(offset, limit, options).then((request) => request(this.axios, this.basePath));
1373
1501
  }
1502
+ /**
1503
+ * 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.
1504
+ * @summary Investment overview table
1505
+ * @param {string} valueFrameworkId UUID of the value framework
1506
+ * @param {*} [options] Override http request option.
1507
+ * @throws {RequiredError}
1508
+ */
1509
+ getInvestmentsOverview(valueFrameworkId, options) {
1510
+ return (0, exports.InvestmentApiFp)(this.configuration).getInvestmentsOverview(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1511
+ }
1374
1512
  /**
1375
1513
  * Retrieve a specific option for the investment.
1376
1514
  * @summary Get an option for this investment
@@ -1383,7 +1521,7 @@ class InvestmentApi extends base_1.BaseAPI {
1383
1521
  return (0, exports.InvestmentApiFp)(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
1384
1522
  }
1385
1523
  /**
1386
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
1524
+ * 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.
1387
1525
  * @summary Get the kpis for a given option inside a value framework
1388
1526
  * @param {string} investmentId UUID of the investment
1389
1527
  * @param {string} optionId UUID of the option
@@ -1406,6 +1544,17 @@ class InvestmentApi extends base_1.BaseAPI {
1406
1544
  getOptionsForInvestment(investmentId, offset, limit, options) {
1407
1545
  return (0, exports.InvestmentApiFp)(this.configuration).getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1408
1546
  }
1547
+ /**
1548
+ * 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.
1549
+ * @summary Option overview table for this investment
1550
+ * @param {string} investmentId UUID of the investment
1551
+ * @param {string} valueFrameworkId UUID of the value framework
1552
+ * @param {*} [options] Override http request option.
1553
+ * @throws {RequiredError}
1554
+ */
1555
+ getOptionsOverview(investmentId, valueFrameworkId, options) {
1556
+ return (0, exports.InvestmentApiFp)(this.configuration).getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1557
+ }
1409
1558
  /**
1410
1559
  * Get the preferred option for an investment.
1411
1560
  * @summary Get the preferred option for an investment
@@ -17,6 +17,7 @@ import type { ImpactCreate } from '../models';
17
17
  import type { ImpactUpdate } from '../models';
18
18
  import type { OptionChartKPIsYearly } from '../models';
19
19
  import type { OptionCreate } from '../models';
20
+ import type { OptionOverviewResponse } from '../models';
20
21
  import type { OptionResponse } from '../models';
21
22
  import type { OptionUpdate } from '../models';
22
23
  /**
@@ -92,7 +93,7 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
92
93
  */
93
94
  getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
94
95
  /**
95
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
96
+ * 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.
96
97
  * @summary Get the kpis for a given option inside a value framework
97
98
  * @param {string} investmentId UUID of the investment
98
99
  * @param {string} optionId UUID of the option
@@ -111,6 +112,15 @@ export declare const OptionApiAxiosParamCreator: (configuration?: Configuration)
111
112
  * @throws {RequiredError}
112
113
  */
113
114
  getOptionsForInvestment: (investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
115
+ /**
116
+ * 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.
117
+ * @summary Option overview table for this investment
118
+ * @param {string} investmentId UUID of the investment
119
+ * @param {string} valueFrameworkId UUID of the value framework
120
+ * @param {*} [options] Override http request option.
121
+ * @throws {RequiredError}
122
+ */
123
+ getOptionsOverview: (investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
114
124
  /**
115
125
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
116
126
  * @summary Partially update an impact for this option
@@ -206,7 +216,7 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
206
216
  */
207
217
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
208
218
  /**
209
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
219
+ * 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.
210
220
  * @summary Get the kpis for a given option inside a value framework
211
221
  * @param {string} investmentId UUID of the investment
212
222
  * @param {string} optionId UUID of the option
@@ -225,6 +235,15 @@ export declare const OptionApiFp: (configuration?: Configuration) => {
225
235
  * @throws {RequiredError}
226
236
  */
227
237
  getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionResponse>>>;
238
+ /**
239
+ * 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.
240
+ * @summary Option overview table for this investment
241
+ * @param {string} investmentId UUID of the investment
242
+ * @param {string} valueFrameworkId UUID of the value framework
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ */
246
+ getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>>;
228
247
  /**
229
248
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
230
249
  * @summary Partially update an impact for this option
@@ -320,7 +339,7 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
320
339
  */
321
340
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
322
341
  /**
323
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
342
+ * 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.
324
343
  * @summary Get the kpis for a given option inside a value framework
325
344
  * @param {string} investmentId UUID of the investment
326
345
  * @param {string} optionId UUID of the option
@@ -339,6 +358,15 @@ export declare const OptionApiFactory: (configuration?: Configuration, basePath?
339
358
  * @throws {RequiredError}
340
359
  */
341
360
  getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>>;
361
+ /**
362
+ * 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.
363
+ * @summary Option overview table for this investment
364
+ * @param {string} investmentId UUID of the investment
365
+ * @param {string} valueFrameworkId UUID of the value framework
366
+ * @param {*} [options] Override http request option.
367
+ * @throws {RequiredError}
368
+ */
369
+ getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>>;
342
370
  /**
343
371
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
344
372
  * @summary Partially update an impact for this option
@@ -434,7 +462,7 @@ export declare class OptionApi extends BaseAPI {
434
462
  */
435
463
  getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
436
464
  /**
437
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
465
+ * 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.
438
466
  * @summary Get the kpis for a given option inside a value framework
439
467
  * @param {string} investmentId UUID of the investment
440
468
  * @param {string} optionId UUID of the option
@@ -453,6 +481,15 @@ export declare class OptionApi extends BaseAPI {
453
481
  * @throws {RequiredError}
454
482
  */
455
483
  getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse[], any, {}>>;
484
+ /**
485
+ * 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.
486
+ * @summary Option overview table for this investment
487
+ * @param {string} investmentId UUID of the investment
488
+ * @param {string} valueFrameworkId UUID of the value framework
489
+ * @param {*} [options] Override http request option.
490
+ * @throws {RequiredError}
491
+ */
492
+ getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionOverviewResponse[], any, {}>>;
456
493
  /**
457
494
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
458
495
  * @summary Partially update an impact for this option
@@ -314,7 +314,7 @@ const OptionApiAxiosParamCreator = function (configuration) {
314
314
  };
315
315
  }),
316
316
  /**
317
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
317
+ * 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.
318
318
  * @summary Get the kpis for a given option inside a value framework
319
319
  * @param {string} investmentId UUID of the investment
320
320
  * @param {string} optionId UUID of the option
@@ -395,6 +395,45 @@ const OptionApiAxiosParamCreator = function (configuration) {
395
395
  options: localVarRequestOptions,
396
396
  };
397
397
  }),
398
+ /**
399
+ * 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.
400
+ * @summary Option overview table for this investment
401
+ * @param {string} investmentId UUID of the investment
402
+ * @param {string} valueFrameworkId UUID of the value framework
403
+ * @param {*} [options] Override http request option.
404
+ * @throws {RequiredError}
405
+ */
406
+ getOptionsOverview: (investmentId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [investmentId_1, valueFrameworkId_1, ...args_1], void 0, function* (investmentId, valueFrameworkId, options = {}) {
407
+ // verify required parameter 'investmentId' is not null or undefined
408
+ (0, common_1.assertParamExists)('getOptionsOverview', 'investmentId', investmentId);
409
+ // verify required parameter 'valueFrameworkId' is not null or undefined
410
+ (0, common_1.assertParamExists)('getOptionsOverview', 'valueFrameworkId', valueFrameworkId);
411
+ const localVarPath = `/investment/{investment_id}/option/overview`
412
+ .replace(`{${"investment_id"}}`, encodeURIComponent(String(investmentId)));
413
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
414
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
415
+ let baseOptions;
416
+ if (configuration) {
417
+ baseOptions = configuration.baseOptions;
418
+ }
419
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
420
+ const localVarHeaderParameter = {};
421
+ const localVarQueryParameter = {};
422
+ // authentication OAuth2AuthorizationCodeBearer required
423
+ // oauth required
424
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
425
+ if (valueFrameworkId !== undefined) {
426
+ localVarQueryParameter['value_framework_id'] = valueFrameworkId;
427
+ }
428
+ localVarHeaderParameter['Accept'] = 'application/json';
429
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
430
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
431
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
432
+ return {
433
+ url: (0, common_1.toPathString)(localVarUrlObj),
434
+ options: localVarRequestOptions,
435
+ };
436
+ }),
398
437
  /**
399
438
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
400
439
  * @summary Partially update an impact for this option
@@ -617,7 +656,7 @@ const OptionApiFp = function (configuration) {
617
656
  });
618
657
  },
619
658
  /**
620
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
659
+ * 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.
621
660
  * @summary Get the kpis for a given option inside a value framework
622
661
  * @param {string} investmentId UUID of the investment
623
662
  * @param {string} optionId UUID of the option
@@ -652,6 +691,23 @@ const OptionApiFp = function (configuration) {
652
691
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
653
692
  });
654
693
  },
694
+ /**
695
+ * 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.
696
+ * @summary Option overview table for this investment
697
+ * @param {string} investmentId UUID of the investment
698
+ * @param {string} valueFrameworkId UUID of the value framework
699
+ * @param {*} [options] Override http request option.
700
+ * @throws {RequiredError}
701
+ */
702
+ getOptionsOverview(investmentId, valueFrameworkId, options) {
703
+ return __awaiter(this, void 0, void 0, function* () {
704
+ var _a, _b, _c;
705
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getOptionsOverview(investmentId, valueFrameworkId, options);
706
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
707
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OptionApi.getOptionsOverview']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
708
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
709
+ });
710
+ },
655
711
  /**
656
712
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
657
713
  * @summary Partially update an impact for this option
@@ -781,7 +837,7 @@ const OptionApiFactory = function (configuration, basePath, axios) {
781
837
  return localVarFp.getOptionForInvestment(optionId, investmentId, options).then((request) => request(axios, basePath));
782
838
  },
783
839
  /**
784
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
840
+ * 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.
785
841
  * @summary Get the kpis for a given option inside a value framework
786
842
  * @param {string} investmentId UUID of the investment
787
843
  * @param {string} optionId UUID of the option
@@ -804,6 +860,17 @@ const OptionApiFactory = function (configuration, basePath, axios) {
804
860
  getOptionsForInvestment(investmentId, offset, limit, options) {
805
861
  return localVarFp.getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(axios, basePath));
806
862
  },
863
+ /**
864
+ * 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.
865
+ * @summary Option overview table for this investment
866
+ * @param {string} investmentId UUID of the investment
867
+ * @param {string} valueFrameworkId UUID of the value framework
868
+ * @param {*} [options] Override http request option.
869
+ * @throws {RequiredError}
870
+ */
871
+ getOptionsOverview(investmentId, valueFrameworkId, options) {
872
+ return localVarFp.getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(axios, basePath));
873
+ },
807
874
  /**
808
875
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
809
876
  * @summary Partially update an impact for this option
@@ -919,7 +986,7 @@ class OptionApi extends base_1.BaseAPI {
919
986
  return (0, exports.OptionApiFp)(this.configuration).getOptionForInvestment(optionId, investmentId, options).then((request) => request(this.axios, this.basePath));
920
987
  }
921
988
  /**
922
- * Return a KPI object containing all the data necessary to display graphs about the option inside a value framework
989
+ * 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.
923
990
  * @summary Get the kpis for a given option inside a value framework
924
991
  * @param {string} investmentId UUID of the investment
925
992
  * @param {string} optionId UUID of the option
@@ -942,6 +1009,17 @@ class OptionApi extends base_1.BaseAPI {
942
1009
  getOptionsForInvestment(investmentId, offset, limit, options) {
943
1010
  return (0, exports.OptionApiFp)(this.configuration).getOptionsForInvestment(investmentId, offset, limit, options).then((request) => request(this.axios, this.basePath));
944
1011
  }
1012
+ /**
1013
+ * 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.
1014
+ * @summary Option overview table for this investment
1015
+ * @param {string} investmentId UUID of the investment
1016
+ * @param {string} valueFrameworkId UUID of the value framework
1017
+ * @param {*} [options] Override http request option.
1018
+ * @throws {RequiredError}
1019
+ */
1020
+ getOptionsOverview(investmentId, valueFrameworkId, options) {
1021
+ return (0, exports.OptionApiFp)(this.configuration).getOptionsOverview(investmentId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1022
+ }
945
1023
  /**
946
1024
  * Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
947
1025
  * @summary Partially update an impact for this option