@cosmotech/aip-client 0.3.0-dev1 → 0.3.0-dev3
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.
- package/README.md +6 -40
- package/api/budget-api.ts +1 -1
- package/api/default-api.ts +1 -1
- package/api/impact-api.ts +90 -1
- package/api/investment-api.ts +68 -1193
- package/api/metric-api.ts +1 -1
- package/api/metric-costs-api.ts +1 -1
- package/api/metric-costs-per-year-api.ts +1 -1
- package/api/objective-api.ts +1 -509
- package/api/objective-weight-api.ts +1 -1
- package/api/objective-weights-api.ts +1 -1
- package/api/option-api.ts +1 -454
- package/api/preferred-option-api.ts +1 -1
- package/api/value-framework-api.ts +61 -1189
- package/api/value-framework-costs-api.ts +1 -1
- package/api/value-framework-weights-api.ts +1 -1
- package/api.ts +1 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api/budget-api.d.ts +1 -1
- package/dist/api/budget-api.js +1 -1
- package/dist/api/default-api.d.ts +1 -1
- package/dist/api/default-api.js +1 -1
- package/dist/api/impact-api.d.ts +42 -1
- package/dist/api/impact-api.js +85 -1
- package/dist/api/investment-api.d.ts +18 -535
- package/dist/api/investment-api.js +79 -1142
- package/dist/api/metric-api.d.ts +1 -1
- package/dist/api/metric-api.js +1 -1
- package/dist/api/metric-costs-api.d.ts +1 -1
- package/dist/api/metric-costs-api.js +1 -1
- package/dist/api/metric-costs-per-year-api.d.ts +1 -1
- package/dist/api/metric-costs-per-year-api.js +1 -1
- package/dist/api/objective-api.d.ts +1 -233
- package/dist/api/objective-api.js +1 -479
- package/dist/api/objective-weight-api.d.ts +1 -1
- package/dist/api/objective-weight-api.js +1 -1
- package/dist/api/objective-weights-api.d.ts +1 -1
- package/dist/api/objective-weights-api.js +1 -1
- package/dist/api/option-api.d.ts +1 -212
- package/dist/api/option-api.js +1 -431
- package/dist/api/preferred-option-api.d.ts +1 -1
- package/dist/api/preferred-option-api.js +1 -1
- package/dist/api/value-framework-api.d.ts +1 -519
- package/dist/api/value-framework-api.js +61 -1128
- package/dist/api/value-framework-costs-api.d.ts +1 -1
- package/dist/api/value-framework-costs-api.js +1 -1
- package/dist/api/value-framework-weights-api.d.ts +1 -1
- package/dist/api/value-framework-weights-api.js +1 -1
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api/budget-api.d.ts +1 -1
- package/dist/esm/api/budget-api.js +1 -1
- package/dist/esm/api/default-api.d.ts +1 -1
- package/dist/esm/api/default-api.js +1 -1
- package/dist/esm/api/impact-api.d.ts +42 -1
- package/dist/esm/api/impact-api.js +85 -1
- package/dist/esm/api/investment-api.d.ts +18 -535
- package/dist/esm/api/investment-api.js +78 -1141
- package/dist/esm/api/metric-api.d.ts +1 -1
- package/dist/esm/api/metric-api.js +1 -1
- package/dist/esm/api/metric-costs-api.d.ts +1 -1
- package/dist/esm/api/metric-costs-api.js +1 -1
- package/dist/esm/api/metric-costs-per-year-api.d.ts +1 -1
- package/dist/esm/api/metric-costs-per-year-api.js +1 -1
- package/dist/esm/api/objective-api.d.ts +1 -233
- package/dist/esm/api/objective-api.js +1 -479
- package/dist/esm/api/objective-weight-api.d.ts +1 -1
- package/dist/esm/api/objective-weight-api.js +1 -1
- package/dist/esm/api/objective-weights-api.d.ts +1 -1
- package/dist/esm/api/objective-weights-api.js +1 -1
- package/dist/esm/api/option-api.d.ts +1 -212
- package/dist/esm/api/option-api.js +1 -431
- package/dist/esm/api/preferred-option-api.d.ts +1 -1
- package/dist/esm/api/preferred-option-api.js +1 -1
- package/dist/esm/api/value-framework-api.d.ts +1 -519
- package/dist/esm/api/value-framework-api.js +61 -1128
- package/dist/esm/api/value-framework-costs-api.d.ts +1 -1
- package/dist/esm/api/value-framework-costs-api.js +1 -1
- package/dist/esm/api/value-framework-weights-api.d.ts +1 -1
- package/dist/esm/api/value-framework-weights-api.js +1 -1
- package/dist/esm/api.d.ts +1 -1
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/budget-bulk-delete-request.d.ts +1 -1
- package/dist/esm/models/budget-bulk-delete-request.js +1 -1
- package/dist/esm/models/budget-create.d.ts +1 -1
- package/dist/esm/models/budget-create.js +1 -1
- package/dist/esm/models/budget-investment-response.d.ts +1 -1
- package/dist/esm/models/budget-investment-response.js +1 -1
- package/dist/esm/models/budget-link-options-request.d.ts +1 -1
- package/dist/esm/models/budget-link-options-request.js +1 -1
- package/dist/esm/models/budget-option-response.d.ts +1 -1
- package/dist/esm/models/budget-option-response.js +1 -1
- package/dist/esm/models/budget-overview-response.d.ts +1 -1
- package/dist/esm/models/budget-overview-response.js +1 -1
- package/dist/esm/models/budget-response.d.ts +1 -1
- package/dist/esm/models/budget-response.js +1 -1
- package/dist/esm/models/budget-update.d.ts +1 -1
- package/dist/esm/models/budget-update.js +1 -1
- package/dist/esm/models/bulk-delete-request.d.ts +20 -0
- package/dist/esm/models/bulk-delete-request.js +14 -0
- package/dist/esm/models/evolution-type.d.ts +1 -1
- package/dist/esm/models/evolution-type.js +1 -1
- package/dist/esm/models/httpvalidation-error.d.ts +1 -1
- package/dist/esm/models/httpvalidation-error.js +1 -1
- package/dist/esm/models/impact-apiresponse.d.ts +1 -1
- package/dist/esm/models/impact-apiresponse.js +1 -1
- package/dist/esm/models/impact-bulk-item.d.ts +37 -0
- package/dist/esm/models/impact-bulk-item.js +14 -0
- package/dist/esm/models/impact-create.d.ts +1 -1
- package/dist/esm/models/impact-create.js +1 -1
- package/dist/esm/models/impact-update.d.ts +1 -1
- package/dist/esm/models/impact-update.js +1 -1
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/esm/models/investment-create.d.ts +1 -1
- package/dist/esm/models/investment-create.js +1 -1
- package/dist/esm/models/investment-overview-response.d.ts +1 -1
- package/dist/esm/models/investment-overview-response.js +1 -1
- package/dist/esm/models/investment-response.d.ts +1 -1
- package/dist/esm/models/investment-response.js +1 -1
- package/dist/esm/models/investment-update.d.ts +1 -1
- package/dist/esm/models/investment-update.js +1 -1
- package/dist/esm/models/location-inner.d.ts +1 -1
- package/dist/esm/models/location-inner.js +1 -1
- package/dist/esm/models/measurement-type.d.ts +1 -1
- package/dist/esm/models/measurement-type.js +1 -1
- package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -1
- package/dist/esm/models/metric-costs-per-year-create.js +1 -1
- package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -1
- package/dist/esm/models/metric-costs-per-year-response.js +1 -1
- package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -1
- package/dist/esm/models/metric-costs-per-year-update.js +1 -1
- package/dist/esm/models/metric-create.d.ts +1 -1
- package/dist/esm/models/metric-create.js +1 -1
- package/dist/esm/models/metric-response.d.ts +1 -1
- package/dist/esm/models/metric-response.js +1 -1
- package/dist/esm/models/metric-type.d.ts +1 -1
- package/dist/esm/models/metric-type.js +1 -1
- package/dist/esm/models/metric-update.d.ts +1 -1
- package/dist/esm/models/metric-update.js +1 -1
- package/dist/esm/models/objective-create.d.ts +1 -1
- package/dist/esm/models/objective-create.js +1 -1
- package/dist/esm/models/objective-response.d.ts +1 -1
- package/dist/esm/models/objective-response.js +1 -1
- package/dist/esm/models/objective-update.d.ts +1 -1
- package/dist/esm/models/objective-update.js +1 -1
- package/dist/esm/models/objective-weight-create.d.ts +1 -1
- package/dist/esm/models/objective-weight-create.js +1 -1
- package/dist/esm/models/objective-weight-response.d.ts +1 -1
- package/dist/esm/models/objective-weight-response.js +1 -1
- package/dist/esm/models/objective-weight-update.d.ts +1 -1
- package/dist/esm/models/objective-weight-update.js +1 -1
- package/dist/esm/models/option-chart-kpi.d.ts +1 -1
- package/dist/esm/models/option-chart-kpi.js +1 -1
- package/dist/esm/models/option-chart-kpis-yearly.d.ts +1 -1
- package/dist/esm/models/option-chart-kpis-yearly.js +1 -1
- package/dist/esm/models/option-create.d.ts +1 -1
- package/dist/esm/models/option-create.js +1 -1
- package/dist/esm/models/option-overview-response.d.ts +1 -1
- package/dist/esm/models/option-overview-response.js +1 -1
- package/dist/esm/models/option-response.d.ts +1 -1
- package/dist/esm/models/option-response.js +1 -1
- package/dist/esm/models/option-update.d.ts +1 -1
- package/dist/esm/models/option-update.js +1 -1
- package/dist/esm/models/preferred-option-request.d.ts +1 -1
- package/dist/esm/models/preferred-option-request.js +1 -1
- package/dist/esm/models/preferred-option-response.d.ts +1 -1
- package/dist/esm/models/preferred-option-response.js +1 -1
- package/dist/esm/models/validation-error.d.ts +1 -1
- package/dist/esm/models/validation-error.js +1 -1
- package/dist/esm/models/value-framework-create.d.ts +1 -1
- package/dist/esm/models/value-framework-create.js +1 -1
- package/dist/esm/models/value-framework-response.d.ts +1 -1
- package/dist/esm/models/value-framework-response.js +1 -1
- package/dist/esm/models/value-framework-update.d.ts +1 -1
- package/dist/esm/models/value-framework-update.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/budget-bulk-delete-request.d.ts +1 -1
- package/dist/models/budget-bulk-delete-request.js +1 -1
- package/dist/models/budget-create.d.ts +1 -1
- package/dist/models/budget-create.js +1 -1
- package/dist/models/budget-investment-response.d.ts +1 -1
- package/dist/models/budget-investment-response.js +1 -1
- package/dist/models/budget-link-options-request.d.ts +1 -1
- package/dist/models/budget-link-options-request.js +1 -1
- package/dist/models/budget-option-response.d.ts +1 -1
- package/dist/models/budget-option-response.js +1 -1
- package/dist/models/budget-overview-response.d.ts +1 -1
- package/dist/models/budget-overview-response.js +1 -1
- package/dist/models/budget-response.d.ts +1 -1
- package/dist/models/budget-response.js +1 -1
- package/dist/models/budget-update.d.ts +1 -1
- package/dist/models/budget-update.js +1 -1
- package/dist/models/bulk-delete-request.d.ts +20 -0
- package/dist/models/bulk-delete-request.js +15 -0
- package/dist/models/evolution-type.d.ts +1 -1
- package/dist/models/evolution-type.js +1 -1
- package/dist/models/httpvalidation-error.d.ts +1 -1
- package/dist/models/httpvalidation-error.js +1 -1
- package/dist/models/impact-apiresponse.d.ts +1 -1
- package/dist/models/impact-apiresponse.js +1 -1
- package/dist/models/impact-bulk-item.d.ts +37 -0
- package/dist/models/impact-bulk-item.js +15 -0
- package/dist/models/impact-create.d.ts +1 -1
- package/dist/models/impact-create.js +1 -1
- package/dist/models/impact-update.d.ts +1 -1
- package/dist/models/impact-update.js +1 -1
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/investment-create.d.ts +1 -1
- package/dist/models/investment-create.js +1 -1
- package/dist/models/investment-overview-response.d.ts +1 -1
- package/dist/models/investment-overview-response.js +1 -1
- package/dist/models/investment-response.d.ts +1 -1
- package/dist/models/investment-response.js +1 -1
- package/dist/models/investment-update.d.ts +1 -1
- package/dist/models/investment-update.js +1 -1
- package/dist/models/location-inner.d.ts +1 -1
- package/dist/models/location-inner.js +1 -1
- package/dist/models/measurement-type.d.ts +1 -1
- package/dist/models/measurement-type.js +1 -1
- package/dist/models/metric-costs-per-year-create.d.ts +1 -1
- package/dist/models/metric-costs-per-year-create.js +1 -1
- package/dist/models/metric-costs-per-year-response.d.ts +1 -1
- package/dist/models/metric-costs-per-year-response.js +1 -1
- package/dist/models/metric-costs-per-year-update.d.ts +1 -1
- package/dist/models/metric-costs-per-year-update.js +1 -1
- package/dist/models/metric-create.d.ts +1 -1
- package/dist/models/metric-create.js +1 -1
- package/dist/models/metric-response.d.ts +1 -1
- package/dist/models/metric-response.js +1 -1
- package/dist/models/metric-type.d.ts +1 -1
- package/dist/models/metric-type.js +1 -1
- package/dist/models/metric-update.d.ts +1 -1
- package/dist/models/metric-update.js +1 -1
- package/dist/models/objective-create.d.ts +1 -1
- package/dist/models/objective-create.js +1 -1
- package/dist/models/objective-response.d.ts +1 -1
- package/dist/models/objective-response.js +1 -1
- package/dist/models/objective-update.d.ts +1 -1
- package/dist/models/objective-update.js +1 -1
- package/dist/models/objective-weight-create.d.ts +1 -1
- package/dist/models/objective-weight-create.js +1 -1
- package/dist/models/objective-weight-response.d.ts +1 -1
- package/dist/models/objective-weight-response.js +1 -1
- package/dist/models/objective-weight-update.d.ts +1 -1
- package/dist/models/objective-weight-update.js +1 -1
- package/dist/models/option-chart-kpi.d.ts +1 -1
- package/dist/models/option-chart-kpi.js +1 -1
- package/dist/models/option-chart-kpis-yearly.d.ts +1 -1
- package/dist/models/option-chart-kpis-yearly.js +1 -1
- package/dist/models/option-create.d.ts +1 -1
- package/dist/models/option-create.js +1 -1
- package/dist/models/option-overview-response.d.ts +1 -1
- package/dist/models/option-overview-response.js +1 -1
- package/dist/models/option-response.d.ts +1 -1
- package/dist/models/option-response.js +1 -1
- package/dist/models/option-update.d.ts +1 -1
- package/dist/models/option-update.js +1 -1
- package/dist/models/preferred-option-request.d.ts +1 -1
- package/dist/models/preferred-option-request.js +1 -1
- package/dist/models/preferred-option-response.d.ts +1 -1
- package/dist/models/preferred-option-response.js +1 -1
- package/dist/models/validation-error.d.ts +1 -1
- package/dist/models/validation-error.js +1 -1
- package/dist/models/value-framework-create.d.ts +1 -1
- package/dist/models/value-framework-create.js +1 -1
- package/dist/models/value-framework-response.d.ts +1 -1
- package/dist/models/value-framework-response.js +1 -1
- package/dist/models/value-framework-update.d.ts +1 -1
- package/dist/models/value-framework-update.js +1 -1
- package/docs/BulkDeleteRequest.md +21 -0
- package/docs/ImpactApi.md +60 -0
- package/docs/ImpactBulkItem.md +29 -0
- package/docs/InvestmentApi.md +43 -811
- package/docs/ObjectiveApi.md +0 -351
- package/docs/OptionApi.md +0 -305
- package/docs/ValueFrameworkApi.md +7 -778
- package/index.ts +1 -1
- package/models/budget-bulk-delete-request.ts +1 -1
- package/models/budget-create.ts +1 -1
- package/models/budget-investment-response.ts +1 -1
- package/models/budget-link-options-request.ts +1 -1
- package/models/budget-option-response.ts +1 -1
- package/models/budget-overview-response.ts +1 -1
- package/models/budget-response.ts +1 -1
- package/models/budget-update.ts +1 -1
- package/models/bulk-delete-request.ts +26 -0
- package/models/evolution-type.ts +1 -1
- package/models/httpvalidation-error.ts +1 -1
- package/models/impact-apiresponse.ts +1 -1
- package/models/impact-bulk-item.ts +47 -0
- package/models/impact-create.ts +1 -1
- package/models/impact-update.ts +1 -1
- package/models/index.ts +2 -0
- package/models/investment-create.ts +1 -1
- package/models/investment-overview-response.ts +1 -1
- package/models/investment-response.ts +1 -1
- package/models/investment-update.ts +1 -1
- package/models/location-inner.ts +1 -1
- package/models/measurement-type.ts +1 -1
- package/models/metric-costs-per-year-create.ts +1 -1
- package/models/metric-costs-per-year-response.ts +1 -1
- package/models/metric-costs-per-year-update.ts +1 -1
- package/models/metric-create.ts +1 -1
- package/models/metric-response.ts +1 -1
- package/models/metric-type.ts +1 -1
- package/models/metric-update.ts +1 -1
- package/models/objective-create.ts +1 -1
- package/models/objective-response.ts +1 -1
- package/models/objective-update.ts +1 -1
- package/models/objective-weight-create.ts +1 -1
- package/models/objective-weight-response.ts +1 -1
- package/models/objective-weight-update.ts +1 -1
- package/models/option-chart-kpi.ts +1 -1
- package/models/option-chart-kpis-yearly.ts +1 -1
- package/models/option-create.ts +1 -1
- package/models/option-overview-response.ts +1 -1
- package/models/option-response.ts +1 -1
- package/models/option-update.ts +1 -1
- package/models/preferred-option-request.ts +1 -1
- package/models/preferred-option-response.ts +1 -1
- package/models/validation-error.ts +1 -1
- package/models/value-framework-create.ts +1 -1
- package/models/value-framework-response.ts +1 -1
- package/models/value-framework-update.ts +1 -1
- package/package.json +1 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Asset Investment Planning
|
|
3
3
|
* API for Asset Investment Planning
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.3.0-
|
|
5
|
+
* The version of the OpenAPI document: 0.3.0-dev3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -12,53 +12,23 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import type {
|
|
16
|
-
import type { ImpactCreate } from '../models';
|
|
17
|
-
import type { ImpactUpdate } from '../models';
|
|
15
|
+
import type { BulkDeleteRequest } from '../models';
|
|
18
16
|
import type { InvestmentCreate } from '../models';
|
|
19
17
|
import type { InvestmentOverviewResponse } from '../models';
|
|
20
18
|
import type { InvestmentResponse } from '../models';
|
|
21
19
|
import type { InvestmentUpdate } from '../models';
|
|
22
|
-
import type { OptionChartKPIsYearly } from '../models';
|
|
23
|
-
import type { OptionCreate } from '../models';
|
|
24
|
-
import type { OptionOverviewResponse } from '../models';
|
|
25
|
-
import type { OptionResponse } from '../models';
|
|
26
|
-
import type { OptionUpdate } from '../models';
|
|
27
|
-
import type { PreferredOptionRequest } from '../models';
|
|
28
|
-
import type { PreferredOptionResponse } from '../models';
|
|
29
20
|
/**
|
|
30
21
|
* InvestmentApi - axios parameter creator
|
|
31
22
|
*/
|
|
32
23
|
export declare const InvestmentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
33
24
|
/**
|
|
34
|
-
*
|
|
35
|
-
* @summary
|
|
36
|
-
* @param {
|
|
37
|
-
* @param {string} investmentId UUID of the investment
|
|
38
|
-
* @param {ImpactCreate} impactCreate
|
|
39
|
-
* @param {*} [options] Override http request option.
|
|
40
|
-
* @throws {RequiredError}
|
|
41
|
-
*/
|
|
42
|
-
createImpactForOption: (optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
|
-
/**
|
|
44
|
-
* Create a new option under this investment.
|
|
45
|
-
* @summary Create an option for this investment
|
|
46
|
-
* @param {string} investmentId UUID of the investment
|
|
47
|
-
* @param {OptionCreate} optionCreate
|
|
48
|
-
* @param {*} [options] Override http request option.
|
|
49
|
-
* @throws {RequiredError}
|
|
50
|
-
*/
|
|
51
|
-
createOptionForInvestment: (investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
|
-
/**
|
|
53
|
-
* Delete an existing impact by its ID.
|
|
54
|
-
* @summary Delete an impact for this option
|
|
55
|
-
* @param {string} impactId UUID of the impact
|
|
56
|
-
* @param {string} optionId UUID of the option
|
|
57
|
-
* @param {string} investmentId UUID of the investment
|
|
25
|
+
* Delete multiple investments by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no investments are deleted. Associated options are also deleted via cascade.
|
|
26
|
+
* @summary Bulk delete investments
|
|
27
|
+
* @param {BulkDeleteRequest} bulkDeleteRequest
|
|
58
28
|
* @param {*} [options] Override http request option.
|
|
59
29
|
* @throws {RequiredError}
|
|
60
30
|
*/
|
|
61
|
-
|
|
31
|
+
bulkDeleteInvestments: (bulkDeleteRequest: BulkDeleteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62
32
|
/**
|
|
63
33
|
* Delete an existing investment by its ID. Associated options are also deleted via cascade.
|
|
64
34
|
* @summary Delete an investment
|
|
@@ -67,36 +37,6 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
|
|
|
67
37
|
* @throws {RequiredError}
|
|
68
38
|
*/
|
|
69
39
|
deleteInvestment: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
|
-
/**
|
|
71
|
-
* Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
|
|
72
|
-
* @summary Delete an option for this investment
|
|
73
|
-
* @param {string} optionId UUID of the option
|
|
74
|
-
* @param {string} investmentId UUID of the investment
|
|
75
|
-
* @param {*} [options] Override http request option.
|
|
76
|
-
* @throws {RequiredError}
|
|
77
|
-
*/
|
|
78
|
-
deleteOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
-
/**
|
|
80
|
-
* Retrieve a specific impact for the option.
|
|
81
|
-
* @summary Get an impact for this option
|
|
82
|
-
* @param {string} impactId UUID of the impact
|
|
83
|
-
* @param {string} optionId UUID of the option
|
|
84
|
-
* @param {string} investmentId UUID of the investment
|
|
85
|
-
* @param {*} [options] Override http request option.
|
|
86
|
-
* @throws {RequiredError}
|
|
87
|
-
*/
|
|
88
|
-
getImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
89
|
-
/**
|
|
90
|
-
* Retrieve a paginated list of all impacts for a specific option.
|
|
91
|
-
* @summary List impacts for this option
|
|
92
|
-
* @param {string} optionId UUID of the option
|
|
93
|
-
* @param {string} investmentId UUID of the investment
|
|
94
|
-
* @param {number} [offset] Number of records to skip
|
|
95
|
-
* @param {number} [limit] Max number of records to return
|
|
96
|
-
* @param {*} [options] Override http request option.
|
|
97
|
-
* @throws {RequiredError}
|
|
98
|
-
*/
|
|
99
|
-
getImpactsForOption: (optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
100
40
|
/**
|
|
101
41
|
* Retrieve a single investment by its ID.
|
|
102
42
|
* @summary Get an investment by ID
|
|
@@ -122,63 +62,6 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
|
|
|
122
62
|
* @throws {RequiredError}
|
|
123
63
|
*/
|
|
124
64
|
getInvestmentsOverview: (valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
125
|
-
/**
|
|
126
|
-
* Retrieve a specific option for the investment.
|
|
127
|
-
* @summary Get an option for this investment
|
|
128
|
-
* @param {string} optionId UUID of the option
|
|
129
|
-
* @param {string} investmentId UUID of the investment
|
|
130
|
-
* @param {*} [options] Override http request option.
|
|
131
|
-
* @throws {RequiredError}
|
|
132
|
-
*/
|
|
133
|
-
getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
134
|
-
/**
|
|
135
|
-
* 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.
|
|
136
|
-
* @summary Get the kpis for a given option inside a value framework
|
|
137
|
-
* @param {string} investmentId UUID of the investment
|
|
138
|
-
* @param {string} optionId UUID of the option
|
|
139
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
140
|
-
* @param {*} [options] Override http request option.
|
|
141
|
-
* @throws {RequiredError}
|
|
142
|
-
*/
|
|
143
|
-
getOptionKpis: (investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
144
|
-
/**
|
|
145
|
-
* Retrieve a paginated list of all options for a specific investment.
|
|
146
|
-
* @summary List options for this investment
|
|
147
|
-
* @param {string} investmentId UUID of the investment
|
|
148
|
-
* @param {number} [offset] Number of records to skip
|
|
149
|
-
* @param {number} [limit] Max number of records to return
|
|
150
|
-
* @param {*} [options] Override http request option.
|
|
151
|
-
* @throws {RequiredError}
|
|
152
|
-
*/
|
|
153
|
-
getOptionsForInvestment: (investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
154
|
-
/**
|
|
155
|
-
* 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.
|
|
156
|
-
* @summary Option overview table for this investment
|
|
157
|
-
* @param {string} investmentId UUID of the investment
|
|
158
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
159
|
-
* @param {*} [options] Override http request option.
|
|
160
|
-
* @throws {RequiredError}
|
|
161
|
-
*/
|
|
162
|
-
getOptionsOverview: (investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
163
|
-
/**
|
|
164
|
-
* Get the preferred option for an investment.
|
|
165
|
-
* @summary Get the preferred option for an investment
|
|
166
|
-
* @param {string} investmentId UUID of the investment
|
|
167
|
-
* @param {*} [options] Override http request option.
|
|
168
|
-
* @throws {RequiredError}
|
|
169
|
-
*/
|
|
170
|
-
getPreferredOption: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
171
|
-
/**
|
|
172
|
-
* Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
173
|
-
* @summary Partially update an impact for this option
|
|
174
|
-
* @param {string} impactId UUID of the impact
|
|
175
|
-
* @param {string} optionId UUID of the option
|
|
176
|
-
* @param {string} investmentId UUID of the investment
|
|
177
|
-
* @param {ImpactUpdate} impactUpdate
|
|
178
|
-
* @param {*} [options] Override http request option.
|
|
179
|
-
* @throws {RequiredError}
|
|
180
|
-
*/
|
|
181
|
-
patchImpactForOption: (impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
182
65
|
/**
|
|
183
66
|
* Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
184
67
|
* @summary Partially update an investment
|
|
@@ -188,16 +71,6 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
|
|
|
188
71
|
* @throws {RequiredError}
|
|
189
72
|
*/
|
|
190
73
|
patchInvestment: (investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
191
|
-
/**
|
|
192
|
-
* Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
193
|
-
* @summary Partially update an option for this investment
|
|
194
|
-
* @param {string} optionId UUID of the option
|
|
195
|
-
* @param {string} investmentId UUID of the investment
|
|
196
|
-
* @param {OptionUpdate} optionUpdate
|
|
197
|
-
* @param {*} [options] Override http request option.
|
|
198
|
-
* @throws {RequiredError}
|
|
199
|
-
*/
|
|
200
|
-
patchOptionForInvestment: (optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
201
74
|
/**
|
|
202
75
|
* Create a new investment.
|
|
203
76
|
* @summary Create an investment
|
|
@@ -206,49 +79,19 @@ export declare const InvestmentApiAxiosParamCreator: (configuration?: Configurat
|
|
|
206
79
|
* @throws {RequiredError}
|
|
207
80
|
*/
|
|
208
81
|
postInvestment: (investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
209
|
-
/**
|
|
210
|
-
* Set the preferred option for an investment.
|
|
211
|
-
* @summary Set the preferred option for an investment
|
|
212
|
-
* @param {string} investmentId UUID of the investment
|
|
213
|
-
* @param {PreferredOptionRequest} preferredOptionRequest
|
|
214
|
-
* @param {*} [options] Override http request option.
|
|
215
|
-
* @throws {RequiredError}
|
|
216
|
-
*/
|
|
217
|
-
setPreferredOption: (investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
218
82
|
};
|
|
219
83
|
/**
|
|
220
84
|
* InvestmentApi - functional programming interface
|
|
221
85
|
*/
|
|
222
86
|
export declare const InvestmentApiFp: (configuration?: Configuration) => {
|
|
223
87
|
/**
|
|
224
|
-
*
|
|
225
|
-
* @summary
|
|
226
|
-
* @param {
|
|
227
|
-
* @param {string} investmentId UUID of the investment
|
|
228
|
-
* @param {ImpactCreate} impactCreate
|
|
229
|
-
* @param {*} [options] Override http request option.
|
|
230
|
-
* @throws {RequiredError}
|
|
231
|
-
*/
|
|
232
|
-
createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
|
|
233
|
-
/**
|
|
234
|
-
* Create a new option under this investment.
|
|
235
|
-
* @summary Create an option for this investment
|
|
236
|
-
* @param {string} investmentId UUID of the investment
|
|
237
|
-
* @param {OptionCreate} optionCreate
|
|
238
|
-
* @param {*} [options] Override http request option.
|
|
239
|
-
* @throws {RequiredError}
|
|
240
|
-
*/
|
|
241
|
-
createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
|
|
242
|
-
/**
|
|
243
|
-
* Delete an existing impact by its ID.
|
|
244
|
-
* @summary Delete an impact for this option
|
|
245
|
-
* @param {string} impactId UUID of the impact
|
|
246
|
-
* @param {string} optionId UUID of the option
|
|
247
|
-
* @param {string} investmentId UUID of the investment
|
|
88
|
+
* Delete multiple investments by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no investments are deleted. Associated options are also deleted via cascade.
|
|
89
|
+
* @summary Bulk delete investments
|
|
90
|
+
* @param {BulkDeleteRequest} bulkDeleteRequest
|
|
248
91
|
* @param {*} [options] Override http request option.
|
|
249
92
|
* @throws {RequiredError}
|
|
250
93
|
*/
|
|
251
|
-
|
|
94
|
+
bulkDeleteInvestments(bulkDeleteRequest: BulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
252
95
|
/**
|
|
253
96
|
* Delete an existing investment by its ID. Associated options are also deleted via cascade.
|
|
254
97
|
* @summary Delete an investment
|
|
@@ -257,36 +100,6 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
|
|
|
257
100
|
* @throws {RequiredError}
|
|
258
101
|
*/
|
|
259
102
|
deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
260
|
-
/**
|
|
261
|
-
* Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
|
|
262
|
-
* @summary Delete an option for this investment
|
|
263
|
-
* @param {string} optionId UUID of the option
|
|
264
|
-
* @param {string} investmentId UUID of the investment
|
|
265
|
-
* @param {*} [options] Override http request option.
|
|
266
|
-
* @throws {RequiredError}
|
|
267
|
-
*/
|
|
268
|
-
deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
269
|
-
/**
|
|
270
|
-
* Retrieve a specific impact for the option.
|
|
271
|
-
* @summary Get an impact for this option
|
|
272
|
-
* @param {string} impactId UUID of the impact
|
|
273
|
-
* @param {string} optionId UUID of the option
|
|
274
|
-
* @param {string} investmentId UUID of the investment
|
|
275
|
-
* @param {*} [options] Override http request option.
|
|
276
|
-
* @throws {RequiredError}
|
|
277
|
-
*/
|
|
278
|
-
getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
|
|
279
|
-
/**
|
|
280
|
-
* Retrieve a paginated list of all impacts for a specific option.
|
|
281
|
-
* @summary List impacts for this option
|
|
282
|
-
* @param {string} optionId UUID of the option
|
|
283
|
-
* @param {string} investmentId UUID of the investment
|
|
284
|
-
* @param {number} [offset] Number of records to skip
|
|
285
|
-
* @param {number} [limit] Max number of records to return
|
|
286
|
-
* @param {*} [options] Override http request option.
|
|
287
|
-
* @throws {RequiredError}
|
|
288
|
-
*/
|
|
289
|
-
getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImpactAPIResponse>>>;
|
|
290
103
|
/**
|
|
291
104
|
* Retrieve a single investment by its ID.
|
|
292
105
|
* @summary Get an investment by ID
|
|
@@ -312,63 +125,6 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
|
|
|
312
125
|
* @throws {RequiredError}
|
|
313
126
|
*/
|
|
314
127
|
getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentOverviewResponse>>>;
|
|
315
|
-
/**
|
|
316
|
-
* Retrieve a specific option for the investment.
|
|
317
|
-
* @summary Get an option for this investment
|
|
318
|
-
* @param {string} optionId UUID of the option
|
|
319
|
-
* @param {string} investmentId UUID of the investment
|
|
320
|
-
* @param {*} [options] Override http request option.
|
|
321
|
-
* @throws {RequiredError}
|
|
322
|
-
*/
|
|
323
|
-
getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
|
|
324
|
-
/**
|
|
325
|
-
* 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.
|
|
326
|
-
* @summary Get the kpis for a given option inside a value framework
|
|
327
|
-
* @param {string} investmentId UUID of the investment
|
|
328
|
-
* @param {string} optionId UUID of the option
|
|
329
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
330
|
-
* @param {*} [options] Override http request option.
|
|
331
|
-
* @throws {RequiredError}
|
|
332
|
-
*/
|
|
333
|
-
getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionChartKPIsYearly>>>;
|
|
334
|
-
/**
|
|
335
|
-
* Retrieve a paginated list of all options for a specific investment.
|
|
336
|
-
* @summary List options for this investment
|
|
337
|
-
* @param {string} investmentId UUID of the investment
|
|
338
|
-
* @param {number} [offset] Number of records to skip
|
|
339
|
-
* @param {number} [limit] Max number of records to return
|
|
340
|
-
* @param {*} [options] Override http request option.
|
|
341
|
-
* @throws {RequiredError}
|
|
342
|
-
*/
|
|
343
|
-
getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionResponse>>>;
|
|
344
|
-
/**
|
|
345
|
-
* 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.
|
|
346
|
-
* @summary Option overview table for this investment
|
|
347
|
-
* @param {string} investmentId UUID of the investment
|
|
348
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
349
|
-
* @param {*} [options] Override http request option.
|
|
350
|
-
* @throws {RequiredError}
|
|
351
|
-
*/
|
|
352
|
-
getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionOverviewResponse>>>;
|
|
353
|
-
/**
|
|
354
|
-
* Get the preferred option for an investment.
|
|
355
|
-
* @summary Get the preferred option for an investment
|
|
356
|
-
* @param {string} investmentId UUID of the investment
|
|
357
|
-
* @param {*} [options] Override http request option.
|
|
358
|
-
* @throws {RequiredError}
|
|
359
|
-
*/
|
|
360
|
-
getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>>;
|
|
361
|
-
/**
|
|
362
|
-
* Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
363
|
-
* @summary Partially update an impact for this option
|
|
364
|
-
* @param {string} impactId UUID of the impact
|
|
365
|
-
* @param {string} optionId UUID of the option
|
|
366
|
-
* @param {string} investmentId UUID of the investment
|
|
367
|
-
* @param {ImpactUpdate} impactUpdate
|
|
368
|
-
* @param {*} [options] Override http request option.
|
|
369
|
-
* @throws {RequiredError}
|
|
370
|
-
*/
|
|
371
|
-
patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
|
|
372
128
|
/**
|
|
373
129
|
* Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
374
130
|
* @summary Partially update an investment
|
|
@@ -378,16 +134,6 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
|
|
|
378
134
|
* @throws {RequiredError}
|
|
379
135
|
*/
|
|
380
136
|
patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
|
|
381
|
-
/**
|
|
382
|
-
* Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
383
|
-
* @summary Partially update an option for this investment
|
|
384
|
-
* @param {string} optionId UUID of the option
|
|
385
|
-
* @param {string} investmentId UUID of the investment
|
|
386
|
-
* @param {OptionUpdate} optionUpdate
|
|
387
|
-
* @param {*} [options] Override http request option.
|
|
388
|
-
* @throws {RequiredError}
|
|
389
|
-
*/
|
|
390
|
-
patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
|
|
391
137
|
/**
|
|
392
138
|
* Create a new investment.
|
|
393
139
|
* @summary Create an investment
|
|
@@ -396,49 +142,19 @@ export declare const InvestmentApiFp: (configuration?: Configuration) => {
|
|
|
396
142
|
* @throws {RequiredError}
|
|
397
143
|
*/
|
|
398
144
|
postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
|
|
399
|
-
/**
|
|
400
|
-
* Set the preferred option for an investment.
|
|
401
|
-
* @summary Set the preferred option for an investment
|
|
402
|
-
* @param {string} investmentId UUID of the investment
|
|
403
|
-
* @param {PreferredOptionRequest} preferredOptionRequest
|
|
404
|
-
* @param {*} [options] Override http request option.
|
|
405
|
-
* @throws {RequiredError}
|
|
406
|
-
*/
|
|
407
|
-
setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferredOptionResponse>>;
|
|
408
145
|
};
|
|
409
146
|
/**
|
|
410
147
|
* InvestmentApi - factory interface
|
|
411
148
|
*/
|
|
412
149
|
export declare const InvestmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
413
150
|
/**
|
|
414
|
-
*
|
|
415
|
-
* @summary
|
|
416
|
-
* @param {
|
|
417
|
-
* @param {string} investmentId UUID of the investment
|
|
418
|
-
* @param {ImpactCreate} impactCreate
|
|
419
|
-
* @param {*} [options] Override http request option.
|
|
420
|
-
* @throws {RequiredError}
|
|
421
|
-
*/
|
|
422
|
-
createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
|
|
423
|
-
/**
|
|
424
|
-
* Create a new option under this investment.
|
|
425
|
-
* @summary Create an option for this investment
|
|
426
|
-
* @param {string} investmentId UUID of the investment
|
|
427
|
-
* @param {OptionCreate} optionCreate
|
|
428
|
-
* @param {*} [options] Override http request option.
|
|
429
|
-
* @throws {RequiredError}
|
|
430
|
-
*/
|
|
431
|
-
createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
|
|
432
|
-
/**
|
|
433
|
-
* Delete an existing impact by its ID.
|
|
434
|
-
* @summary Delete an impact for this option
|
|
435
|
-
* @param {string} impactId UUID of the impact
|
|
436
|
-
* @param {string} optionId UUID of the option
|
|
437
|
-
* @param {string} investmentId UUID of the investment
|
|
151
|
+
* Delete multiple investments by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no investments are deleted. Associated options are also deleted via cascade.
|
|
152
|
+
* @summary Bulk delete investments
|
|
153
|
+
* @param {BulkDeleteRequest} bulkDeleteRequest
|
|
438
154
|
* @param {*} [options] Override http request option.
|
|
439
155
|
* @throws {RequiredError}
|
|
440
156
|
*/
|
|
441
|
-
|
|
157
|
+
bulkDeleteInvestments(bulkDeleteRequest: BulkDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
442
158
|
/**
|
|
443
159
|
* Delete an existing investment by its ID. Associated options are also deleted via cascade.
|
|
444
160
|
* @summary Delete an investment
|
|
@@ -447,36 +163,6 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
|
|
|
447
163
|
* @throws {RequiredError}
|
|
448
164
|
*/
|
|
449
165
|
deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
450
|
-
/**
|
|
451
|
-
* Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
|
|
452
|
-
* @summary Delete an option for this investment
|
|
453
|
-
* @param {string} optionId UUID of the option
|
|
454
|
-
* @param {string} investmentId UUID of the investment
|
|
455
|
-
* @param {*} [options] Override http request option.
|
|
456
|
-
* @throws {RequiredError}
|
|
457
|
-
*/
|
|
458
|
-
deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
459
|
-
/**
|
|
460
|
-
* Retrieve a specific impact for the option.
|
|
461
|
-
* @summary Get an impact for this option
|
|
462
|
-
* @param {string} impactId UUID of the impact
|
|
463
|
-
* @param {string} optionId UUID of the option
|
|
464
|
-
* @param {string} investmentId UUID of the investment
|
|
465
|
-
* @param {*} [options] Override http request option.
|
|
466
|
-
* @throws {RequiredError}
|
|
467
|
-
*/
|
|
468
|
-
getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
|
|
469
|
-
/**
|
|
470
|
-
* Retrieve a paginated list of all impacts for a specific option.
|
|
471
|
-
* @summary List impacts for this option
|
|
472
|
-
* @param {string} optionId UUID of the option
|
|
473
|
-
* @param {string} investmentId UUID of the investment
|
|
474
|
-
* @param {number} [offset] Number of records to skip
|
|
475
|
-
* @param {number} [limit] Max number of records to return
|
|
476
|
-
* @param {*} [options] Override http request option.
|
|
477
|
-
* @throws {RequiredError}
|
|
478
|
-
*/
|
|
479
|
-
getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ImpactAPIResponse>>;
|
|
480
166
|
/**
|
|
481
167
|
* Retrieve a single investment by its ID.
|
|
482
168
|
* @summary Get an investment by ID
|
|
@@ -502,63 +188,6 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
|
|
|
502
188
|
* @throws {RequiredError}
|
|
503
189
|
*/
|
|
504
190
|
getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentOverviewResponse>>;
|
|
505
|
-
/**
|
|
506
|
-
* Retrieve a specific option for the investment.
|
|
507
|
-
* @summary Get an option for this investment
|
|
508
|
-
* @param {string} optionId UUID of the option
|
|
509
|
-
* @param {string} investmentId UUID of the investment
|
|
510
|
-
* @param {*} [options] Override http request option.
|
|
511
|
-
* @throws {RequiredError}
|
|
512
|
-
*/
|
|
513
|
-
getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
|
|
514
|
-
/**
|
|
515
|
-
* 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.
|
|
516
|
-
* @summary Get the kpis for a given option inside a value framework
|
|
517
|
-
* @param {string} investmentId UUID of the investment
|
|
518
|
-
* @param {string} optionId UUID of the option
|
|
519
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
520
|
-
* @param {*} [options] Override http request option.
|
|
521
|
-
* @throws {RequiredError}
|
|
522
|
-
*/
|
|
523
|
-
getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionChartKPIsYearly>>;
|
|
524
|
-
/**
|
|
525
|
-
* Retrieve a paginated list of all options for a specific investment.
|
|
526
|
-
* @summary List options for this investment
|
|
527
|
-
* @param {string} investmentId UUID of the investment
|
|
528
|
-
* @param {number} [offset] Number of records to skip
|
|
529
|
-
* @param {number} [limit] Max number of records to return
|
|
530
|
-
* @param {*} [options] Override http request option.
|
|
531
|
-
* @throws {RequiredError}
|
|
532
|
-
*/
|
|
533
|
-
getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>>;
|
|
534
|
-
/**
|
|
535
|
-
* 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.
|
|
536
|
-
* @summary Option overview table for this investment
|
|
537
|
-
* @param {string} investmentId UUID of the investment
|
|
538
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
539
|
-
* @param {*} [options] Override http request option.
|
|
540
|
-
* @throws {RequiredError}
|
|
541
|
-
*/
|
|
542
|
-
getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionOverviewResponse>>;
|
|
543
|
-
/**
|
|
544
|
-
* Get the preferred option for an investment.
|
|
545
|
-
* @summary Get the preferred option for an investment
|
|
546
|
-
* @param {string} investmentId UUID of the investment
|
|
547
|
-
* @param {*} [options] Override http request option.
|
|
548
|
-
* @throws {RequiredError}
|
|
549
|
-
*/
|
|
550
|
-
getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse>;
|
|
551
|
-
/**
|
|
552
|
-
* Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
553
|
-
* @summary Partially update an impact for this option
|
|
554
|
-
* @param {string} impactId UUID of the impact
|
|
555
|
-
* @param {string} optionId UUID of the option
|
|
556
|
-
* @param {string} investmentId UUID of the investment
|
|
557
|
-
* @param {ImpactUpdate} impactUpdate
|
|
558
|
-
* @param {*} [options] Override http request option.
|
|
559
|
-
* @throws {RequiredError}
|
|
560
|
-
*/
|
|
561
|
-
patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
|
|
562
191
|
/**
|
|
563
192
|
* Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
564
193
|
* @summary Partially update an investment
|
|
@@ -568,16 +197,6 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
|
|
|
568
197
|
* @throws {RequiredError}
|
|
569
198
|
*/
|
|
570
199
|
patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
|
|
571
|
-
/**
|
|
572
|
-
* Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
573
|
-
* @summary Partially update an option for this investment
|
|
574
|
-
* @param {string} optionId UUID of the option
|
|
575
|
-
* @param {string} investmentId UUID of the investment
|
|
576
|
-
* @param {OptionUpdate} optionUpdate
|
|
577
|
-
* @param {*} [options] Override http request option.
|
|
578
|
-
* @throws {RequiredError}
|
|
579
|
-
*/
|
|
580
|
-
patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
|
|
581
200
|
/**
|
|
582
201
|
* Create a new investment.
|
|
583
202
|
* @summary Create an investment
|
|
@@ -586,49 +205,19 @@ export declare const InvestmentApiFactory: (configuration?: Configuration, baseP
|
|
|
586
205
|
* @throws {RequiredError}
|
|
587
206
|
*/
|
|
588
207
|
postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
|
|
589
|
-
/**
|
|
590
|
-
* Set the preferred option for an investment.
|
|
591
|
-
* @summary Set the preferred option for an investment
|
|
592
|
-
* @param {string} investmentId UUID of the investment
|
|
593
|
-
* @param {PreferredOptionRequest} preferredOptionRequest
|
|
594
|
-
* @param {*} [options] Override http request option.
|
|
595
|
-
* @throws {RequiredError}
|
|
596
|
-
*/
|
|
597
|
-
setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PreferredOptionResponse>;
|
|
598
208
|
};
|
|
599
209
|
/**
|
|
600
210
|
* InvestmentApi - object-oriented interface
|
|
601
211
|
*/
|
|
602
212
|
export declare class InvestmentApi extends BaseAPI {
|
|
603
213
|
/**
|
|
604
|
-
*
|
|
605
|
-
* @summary
|
|
606
|
-
* @param {
|
|
607
|
-
* @param {string} investmentId UUID of the investment
|
|
608
|
-
* @param {ImpactCreate} impactCreate
|
|
609
|
-
* @param {*} [options] Override http request option.
|
|
610
|
-
* @throws {RequiredError}
|
|
611
|
-
*/
|
|
612
|
-
createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
|
|
613
|
-
/**
|
|
614
|
-
* Create a new option under this investment.
|
|
615
|
-
* @summary Create an option for this investment
|
|
616
|
-
* @param {string} investmentId UUID of the investment
|
|
617
|
-
* @param {OptionCreate} optionCreate
|
|
618
|
-
* @param {*} [options] Override http request option.
|
|
619
|
-
* @throws {RequiredError}
|
|
620
|
-
*/
|
|
621
|
-
createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
|
|
622
|
-
/**
|
|
623
|
-
* Delete an existing impact by its ID.
|
|
624
|
-
* @summary Delete an impact for this option
|
|
625
|
-
* @param {string} impactId UUID of the impact
|
|
626
|
-
* @param {string} optionId UUID of the option
|
|
627
|
-
* @param {string} investmentId UUID of the investment
|
|
214
|
+
* Delete multiple investments by their IDs in a single request. All provided IDs must exist — if any ID is not found, the request fails with 404 and no investments are deleted. Associated options are also deleted via cascade.
|
|
215
|
+
* @summary Bulk delete investments
|
|
216
|
+
* @param {BulkDeleteRequest} bulkDeleteRequest
|
|
628
217
|
* @param {*} [options] Override http request option.
|
|
629
218
|
* @throws {RequiredError}
|
|
630
219
|
*/
|
|
631
|
-
|
|
220
|
+
bulkDeleteInvestments(bulkDeleteRequest: BulkDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
632
221
|
/**
|
|
633
222
|
* Delete an existing investment by its ID. Associated options are also deleted via cascade.
|
|
634
223
|
* @summary Delete an investment
|
|
@@ -637,36 +226,6 @@ export declare class InvestmentApi extends BaseAPI {
|
|
|
637
226
|
* @throws {RequiredError}
|
|
638
227
|
*/
|
|
639
228
|
deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
640
|
-
/**
|
|
641
|
-
* Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
|
|
642
|
-
* @summary Delete an option for this investment
|
|
643
|
-
* @param {string} optionId UUID of the option
|
|
644
|
-
* @param {string} investmentId UUID of the investment
|
|
645
|
-
* @param {*} [options] Override http request option.
|
|
646
|
-
* @throws {RequiredError}
|
|
647
|
-
*/
|
|
648
|
-
deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
649
|
-
/**
|
|
650
|
-
* Retrieve a specific impact for the option.
|
|
651
|
-
* @summary Get an impact for this option
|
|
652
|
-
* @param {string} impactId UUID of the impact
|
|
653
|
-
* @param {string} optionId UUID of the option
|
|
654
|
-
* @param {string} investmentId UUID of the investment
|
|
655
|
-
* @param {*} [options] Override http request option.
|
|
656
|
-
* @throws {RequiredError}
|
|
657
|
-
*/
|
|
658
|
-
getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
|
|
659
|
-
/**
|
|
660
|
-
* Retrieve a paginated list of all impacts for a specific option.
|
|
661
|
-
* @summary List impacts for this option
|
|
662
|
-
* @param {string} optionId UUID of the option
|
|
663
|
-
* @param {string} investmentId UUID of the investment
|
|
664
|
-
* @param {number} [offset] Number of records to skip
|
|
665
|
-
* @param {number} [limit] Max number of records to return
|
|
666
|
-
* @param {*} [options] Override http request option.
|
|
667
|
-
* @throws {RequiredError}
|
|
668
|
-
*/
|
|
669
|
-
getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse[], any, {}>>;
|
|
670
229
|
/**
|
|
671
230
|
* Retrieve a single investment by its ID.
|
|
672
231
|
* @summary Get an investment by ID
|
|
@@ -692,63 +251,6 @@ export declare class InvestmentApi extends BaseAPI {
|
|
|
692
251
|
* @throws {RequiredError}
|
|
693
252
|
*/
|
|
694
253
|
getInvestmentsOverview(valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentOverviewResponse[], any, {}>>;
|
|
695
|
-
/**
|
|
696
|
-
* Retrieve a specific option for the investment.
|
|
697
|
-
* @summary Get an option for this investment
|
|
698
|
-
* @param {string} optionId UUID of the option
|
|
699
|
-
* @param {string} investmentId UUID of the investment
|
|
700
|
-
* @param {*} [options] Override http request option.
|
|
701
|
-
* @throws {RequiredError}
|
|
702
|
-
*/
|
|
703
|
-
getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
|
|
704
|
-
/**
|
|
705
|
-
* 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.
|
|
706
|
-
* @summary Get the kpis for a given option inside a value framework
|
|
707
|
-
* @param {string} investmentId UUID of the investment
|
|
708
|
-
* @param {string} optionId UUID of the option
|
|
709
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
710
|
-
* @param {*} [options] Override http request option.
|
|
711
|
-
* @throws {RequiredError}
|
|
712
|
-
*/
|
|
713
|
-
getOptionKpis(investmentId: string, optionId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionChartKPIsYearly[], any, {}>>;
|
|
714
|
-
/**
|
|
715
|
-
* Retrieve a paginated list of all options for a specific investment.
|
|
716
|
-
* @summary List options for this investment
|
|
717
|
-
* @param {string} investmentId UUID of the investment
|
|
718
|
-
* @param {number} [offset] Number of records to skip
|
|
719
|
-
* @param {number} [limit] Max number of records to return
|
|
720
|
-
* @param {*} [options] Override http request option.
|
|
721
|
-
* @throws {RequiredError}
|
|
722
|
-
*/
|
|
723
|
-
getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse[], any, {}>>;
|
|
724
|
-
/**
|
|
725
|
-
* 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.
|
|
726
|
-
* @summary Option overview table for this investment
|
|
727
|
-
* @param {string} investmentId UUID of the investment
|
|
728
|
-
* @param {string} valueFrameworkId UUID of the value framework
|
|
729
|
-
* @param {*} [options] Override http request option.
|
|
730
|
-
* @throws {RequiredError}
|
|
731
|
-
*/
|
|
732
|
-
getOptionsOverview(investmentId: string, valueFrameworkId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionOverviewResponse[], any, {}>>;
|
|
733
|
-
/**
|
|
734
|
-
* Get the preferred option for an investment.
|
|
735
|
-
* @summary Get the preferred option for an investment
|
|
736
|
-
* @param {string} investmentId UUID of the investment
|
|
737
|
-
* @param {*} [options] Override http request option.
|
|
738
|
-
* @throws {RequiredError}
|
|
739
|
-
*/
|
|
740
|
-
getPreferredOption(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferredOptionResponse, any, {}>>;
|
|
741
|
-
/**
|
|
742
|
-
* Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
743
|
-
* @summary Partially update an impact for this option
|
|
744
|
-
* @param {string} impactId UUID of the impact
|
|
745
|
-
* @param {string} optionId UUID of the option
|
|
746
|
-
* @param {string} investmentId UUID of the investment
|
|
747
|
-
* @param {ImpactUpdate} impactUpdate
|
|
748
|
-
* @param {*} [options] Override http request option.
|
|
749
|
-
* @throws {RequiredError}
|
|
750
|
-
*/
|
|
751
|
-
patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
|
|
752
254
|
/**
|
|
753
255
|
* Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
754
256
|
* @summary Partially update an investment
|
|
@@ -758,16 +260,6 @@ export declare class InvestmentApi extends BaseAPI {
|
|
|
758
260
|
* @throws {RequiredError}
|
|
759
261
|
*/
|
|
760
262
|
patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
|
|
761
|
-
/**
|
|
762
|
-
* Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
763
|
-
* @summary Partially update an option for this investment
|
|
764
|
-
* @param {string} optionId UUID of the option
|
|
765
|
-
* @param {string} investmentId UUID of the investment
|
|
766
|
-
* @param {OptionUpdate} optionUpdate
|
|
767
|
-
* @param {*} [options] Override http request option.
|
|
768
|
-
* @throws {RequiredError}
|
|
769
|
-
*/
|
|
770
|
-
patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
|
|
771
263
|
/**
|
|
772
264
|
* Create a new investment.
|
|
773
265
|
* @summary Create an investment
|
|
@@ -776,13 +268,4 @@ export declare class InvestmentApi extends BaseAPI {
|
|
|
776
268
|
* @throws {RequiredError}
|
|
777
269
|
*/
|
|
778
270
|
postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
|
|
779
|
-
/**
|
|
780
|
-
* Set the preferred option for an investment.
|
|
781
|
-
* @summary Set the preferred option for an investment
|
|
782
|
-
* @param {string} investmentId UUID of the investment
|
|
783
|
-
* @param {PreferredOptionRequest} preferredOptionRequest
|
|
784
|
-
* @param {*} [options] Override http request option.
|
|
785
|
-
* @throws {RequiredError}
|
|
786
|
-
*/
|
|
787
|
-
setPreferredOption(investmentId: string, preferredOptionRequest: PreferredOptionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferredOptionResponse, any, {}>>;
|
|
788
271
|
}
|