@cosmotech/aip-client 0.2.0-dev2 → 0.2.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 +141 -4
- package/api/default-api.ts +8 -15
- package/api/impact-api.ts +507 -0
- package/api/investment-api.ts +1308 -0
- package/api/metric-api.ts +185 -164
- package/api/metric-costs-api.ts +144 -0
- package/api/metric-costs-per-year-api.ts +200 -200
- package/api/objective-api.ts +538 -44
- package/api/objective-weight-api.ts +190 -190
- package/api/objective-weights-api.ts +144 -0
- package/api/option-api.ts +925 -0
- package/api/value-framework-api.ts +1223 -109
- package/api/value-framework-costs-api.ts +239 -0
- package/api/value-framework-weights-api.ts +144 -0
- package/api.ts +8 -1
- package/base.ts +1 -25
- package/common.ts +20 -43
- package/configuration.ts +31 -20
- package/dist/api/default-api.d.ts +3 -10
- package/dist/api/default-api.js +7 -13
- package/dist/api/impact-api.d.ts +245 -0
- package/dist/api/impact-api.js +493 -0
- package/dist/api/investment-api.d.ts +607 -0
- package/dist/api/investment-api.js +1248 -0
- package/dist/api/metric-api.d.ts +97 -88
- package/dist/api/metric-api.js +185 -157
- package/dist/api/metric-costs-api.d.ts +75 -0
- package/dist/api/metric-costs-api.js +146 -0
- package/dist/api/metric-costs-per-year-api.d.ts +105 -108
- package/dist/api/metric-costs-per-year-api.js +199 -192
- package/dist/api/objective-api.d.ts +242 -21
- package/dist/api/objective-api.js +508 -37
- package/dist/api/objective-weight-api.d.ts +105 -108
- package/dist/api/objective-weight-api.js +189 -182
- package/dist/api/objective-weights-api.d.ts +75 -0
- package/dist/api/objective-weights-api.js +146 -0
- package/dist/api/option-api.d.ts +436 -0
- package/dist/api/option-api.js +888 -0
- package/dist/api/value-framework-api.d.ts +528 -21
- package/dist/api/value-framework-api.js +1138 -78
- package/dist/api/value-framework-costs-api.d.ts +119 -0
- package/dist/api/value-framework-costs-api.js +236 -0
- package/dist/api/value-framework-weights-api.d.ts +75 -0
- package/dist/api/value-framework-weights-api.js +146 -0
- package/dist/api.d.ts +8 -1
- package/dist/api.js +8 -1
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +6 -37
- package/dist/common.js +17 -39
- package/dist/configuration.d.ts +25 -18
- package/dist/configuration.js +4 -3
- package/dist/esm/api/default-api.d.ts +3 -10
- package/dist/esm/api/default-api.js +7 -13
- package/dist/esm/api/impact-api.d.ts +245 -0
- package/dist/esm/api/impact-api.js +486 -0
- package/dist/esm/api/investment-api.d.ts +607 -0
- package/dist/esm/api/investment-api.js +1241 -0
- package/dist/esm/api/metric-api.d.ts +97 -88
- package/dist/esm/api/metric-api.js +185 -157
- package/dist/esm/api/metric-costs-api.d.ts +75 -0
- package/dist/esm/api/metric-costs-api.js +139 -0
- package/dist/esm/api/metric-costs-per-year-api.d.ts +105 -108
- package/dist/esm/api/metric-costs-per-year-api.js +199 -192
- package/dist/esm/api/objective-api.d.ts +242 -21
- package/dist/esm/api/objective-api.js +508 -37
- package/dist/esm/api/objective-weight-api.d.ts +105 -108
- package/dist/esm/api/objective-weight-api.js +189 -182
- package/dist/esm/api/objective-weights-api.d.ts +75 -0
- package/dist/esm/api/objective-weights-api.js +139 -0
- package/dist/esm/api/option-api.d.ts +436 -0
- package/dist/esm/api/option-api.js +881 -0
- package/dist/esm/api/value-framework-api.d.ts +528 -21
- package/dist/esm/api/value-framework-api.js +1137 -77
- package/dist/esm/api/value-framework-costs-api.d.ts +119 -0
- package/dist/esm/api/value-framework-costs-api.js +229 -0
- package/dist/esm/api/value-framework-weights-api.d.ts +75 -0
- package/dist/esm/api/value-framework-weights-api.js +139 -0
- package/dist/esm/api.d.ts +8 -1
- package/dist/esm/api.js +8 -1
- package/dist/esm/base.d.ts +1 -25
- package/dist/esm/base.js +1 -20
- package/dist/esm/common.d.ts +6 -37
- package/dist/esm/common.js +15 -38
- package/dist/esm/configuration.d.ts +25 -18
- package/dist/esm/configuration.js +4 -3
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/models/evolution-type.d.ts +16 -0
- package/dist/esm/models/evolution-type.js +17 -0
- package/dist/esm/models/httpvalidation-error.d.ts +2 -12
- package/dist/esm/models/httpvalidation-error.js +1 -1
- package/dist/esm/models/impact-apiresponse.d.ts +33 -0
- package/dist/esm/models/{validation-error-loc-inner.js → impact-apiresponse.js} +1 -1
- package/dist/esm/models/impact-create.d.ts +37 -0
- package/dist/esm/models/impact-create.js +14 -0
- package/dist/esm/models/impact-update.d.ts +22 -0
- package/dist/esm/models/impact-update.js +14 -0
- package/dist/esm/models/index.d.ts +11 -1
- package/dist/esm/models/index.js +11 -1
- package/dist/esm/models/investment-create.d.ts +21 -0
- package/dist/esm/models/investment-create.js +14 -0
- package/dist/esm/models/investment-response.d.ts +25 -0
- package/dist/esm/models/investment-response.js +14 -0
- package/dist/esm/models/investment-update.d.ts +18 -0
- package/dist/esm/models/investment-update.js +14 -0
- package/dist/esm/models/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
- package/dist/esm/models/location-inner.js +14 -0
- package/dist/esm/models/measurement-type.d.ts +1 -6
- package/dist/esm/models/measurement-type.js +1 -6
- package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -17
- package/dist/esm/models/metric-costs-per-year-create.js +1 -1
- package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -18
- package/dist/esm/models/metric-costs-per-year-response.js +1 -1
- package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -13
- package/dist/esm/models/metric-costs-per-year-update.js +1 -1
- package/dist/esm/models/metric-create.d.ts +3 -28
- package/dist/esm/models/metric-create.js +1 -1
- package/dist/esm/models/metric-response.d.ts +3 -50
- package/dist/esm/models/metric-response.js +1 -1
- package/dist/esm/models/metric-type.d.ts +1 -6
- package/dist/esm/models/metric-type.js +1 -6
- package/dist/esm/models/metric-update.d.ts +3 -35
- package/dist/esm/models/metric-update.js +1 -1
- package/dist/esm/models/objective-create.d.ts +1 -10
- package/dist/esm/models/objective-create.js +1 -1
- package/dist/esm/models/objective-response.d.ts +1 -30
- package/dist/esm/models/objective-response.js +1 -1
- package/dist/esm/models/objective-update.d.ts +1 -13
- package/dist/esm/models/objective-update.js +1 -1
- package/dist/esm/models/objective-weight-create.d.ts +1 -9
- package/dist/esm/models/objective-weight-create.js +1 -1
- package/dist/esm/models/objective-weight-response.d.ts +1 -14
- package/dist/esm/models/objective-weight-response.js +1 -1
- package/dist/esm/models/objective-weight-update.d.ts +1 -8
- package/dist/esm/models/objective-weight-update.js +1 -1
- package/dist/esm/models/option-create.d.ts +33 -0
- package/dist/esm/models/option-create.js +14 -0
- package/dist/esm/models/option-response.d.ts +31 -0
- package/dist/esm/models/option-response.js +14 -0
- package/dist/esm/models/option-update.d.ts +19 -0
- package/dist/esm/models/option-update.js +14 -0
- package/dist/esm/models/validation-error.d.ts +3 -33
- package/dist/esm/models/validation-error.js +1 -1
- package/dist/esm/models/value-framework-create.d.ts +1 -10
- package/dist/esm/models/value-framework-create.js +1 -1
- package/dist/esm/models/value-framework-response.d.ts +1 -30
- package/dist/esm/models/value-framework-response.js +1 -1
- package/dist/esm/models/value-framework-update.d.ts +1 -13
- 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/evolution-type.d.ts +16 -0
- package/dist/models/evolution-type.js +20 -0
- package/dist/models/httpvalidation-error.d.ts +2 -12
- package/dist/models/httpvalidation-error.js +1 -1
- package/dist/models/impact-apiresponse.d.ts +33 -0
- package/dist/models/{validation-error-loc-inner.js → impact-apiresponse.js} +1 -1
- package/dist/models/impact-create.d.ts +37 -0
- package/dist/models/impact-create.js +15 -0
- package/dist/models/impact-update.d.ts +22 -0
- package/dist/models/impact-update.js +15 -0
- package/dist/models/index.d.ts +11 -1
- package/dist/models/index.js +11 -1
- package/dist/models/investment-create.d.ts +21 -0
- package/dist/models/investment-create.js +15 -0
- package/dist/models/investment-response.d.ts +25 -0
- package/dist/models/investment-response.js +15 -0
- package/dist/models/investment-update.d.ts +18 -0
- package/dist/models/investment-update.js +15 -0
- package/dist/models/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
- package/dist/models/location-inner.js +15 -0
- package/dist/models/measurement-type.d.ts +1 -6
- package/dist/models/measurement-type.js +1 -6
- package/dist/models/metric-costs-per-year-create.d.ts +1 -17
- package/dist/models/metric-costs-per-year-create.js +1 -1
- package/dist/models/metric-costs-per-year-response.d.ts +1 -18
- package/dist/models/metric-costs-per-year-response.js +1 -1
- package/dist/models/metric-costs-per-year-update.d.ts +1 -13
- package/dist/models/metric-costs-per-year-update.js +1 -1
- package/dist/models/metric-create.d.ts +3 -28
- package/dist/models/metric-create.js +1 -1
- package/dist/models/metric-response.d.ts +3 -50
- package/dist/models/metric-response.js +1 -1
- package/dist/models/metric-type.d.ts +1 -6
- package/dist/models/metric-type.js +1 -6
- package/dist/models/metric-update.d.ts +3 -35
- package/dist/models/metric-update.js +1 -1
- package/dist/models/objective-create.d.ts +1 -10
- package/dist/models/objective-create.js +1 -1
- package/dist/models/objective-response.d.ts +1 -30
- package/dist/models/objective-response.js +1 -1
- package/dist/models/objective-update.d.ts +1 -13
- package/dist/models/objective-update.js +1 -1
- package/dist/models/objective-weight-create.d.ts +1 -9
- package/dist/models/objective-weight-create.js +1 -1
- package/dist/models/objective-weight-response.d.ts +1 -14
- package/dist/models/objective-weight-response.js +1 -1
- package/dist/models/objective-weight-update.d.ts +1 -8
- package/dist/models/objective-weight-update.js +1 -1
- package/dist/models/option-create.d.ts +33 -0
- package/dist/models/option-create.js +15 -0
- package/dist/models/option-response.d.ts +31 -0
- package/dist/models/option-response.js +15 -0
- package/dist/models/option-update.d.ts +19 -0
- package/dist/models/option-update.js +15 -0
- package/dist/models/validation-error.d.ts +3 -33
- package/dist/models/validation-error.js +1 -1
- package/dist/models/value-framework-create.d.ts +1 -10
- package/dist/models/value-framework-create.js +1 -1
- package/dist/models/value-framework-response.d.ts +1 -30
- package/dist/models/value-framework-response.js +1 -1
- package/dist/models/value-framework-update.d.ts +1 -13
- package/dist/models/value-framework-update.js +1 -1
- package/docs/DefaultApi.md +51 -0
- package/docs/EvolutionType.md +10 -0
- package/docs/HTTPValidationError.md +20 -0
- package/docs/ImpactAPIResponse.md +39 -0
- package/docs/ImpactApi.md +312 -0
- package/docs/ImpactCreate.md +29 -0
- package/docs/ImpactUpdate.md +29 -0
- package/docs/InvestmentApi.md +875 -0
- package/docs/InvestmentCreate.md +23 -0
- package/docs/InvestmentResponse.md +31 -0
- package/docs/InvestmentUpdate.md +23 -0
- package/docs/LocationInner.md +18 -0
- package/docs/MeasurementType.md +10 -0
- package/docs/MetricApi.md +299 -0
- package/docs/MetricCostsApi.md +66 -0
- package/docs/MetricCostsPerYearApi.md +307 -0
- package/docs/MetricCostsPerYearCreate.md +27 -0
- package/docs/MetricCostsPerYearResponse.md +31 -0
- package/docs/MetricCostsPerYearUpdate.md +23 -0
- package/docs/MetricCreate.md +33 -0
- package/docs/MetricResponse.md +43 -0
- package/docs/MetricType.md +12 -0
- package/docs/MetricUpdate.md +31 -0
- package/docs/ObjectiveApi.md +633 -0
- package/docs/ObjectiveCreate.md +23 -0
- package/docs/ObjectiveResponse.md +31 -0
- package/docs/ObjectiveUpdate.md +23 -0
- package/docs/ObjectiveWeightApi.md +298 -0
- package/docs/ObjectiveWeightCreate.md +25 -0
- package/docs/ObjectiveWeightResponse.md +27 -0
- package/docs/ObjectiveWeightUpdate.md +21 -0
- package/docs/ObjectiveWeightsApi.md +66 -0
- package/docs/OptionApi.md +602 -0
- package/docs/OptionCreate.md +29 -0
- package/docs/OptionResponse.md +37 -0
- package/docs/OptionUpdate.md +25 -0
- package/docs/ValidationError.md +28 -0
- package/docs/ValueFrameworkApi.md +1053 -0
- package/docs/ValueFrameworkCostsApi.md +128 -0
- package/docs/ValueFrameworkCreate.md +23 -0
- package/docs/ValueFrameworkResponse.md +31 -0
- package/docs/ValueFrameworkUpdate.md +23 -0
- package/docs/ValueFrameworkWeightsApi.md +66 -0
- package/index.ts +1 -1
- package/models/evolution-type.ts +26 -0
- package/models/httpvalidation-error.ts +2 -12
- package/models/impact-apiresponse.ts +43 -0
- package/models/impact-create.ts +47 -0
- package/models/impact-update.ts +32 -0
- package/models/index.ts +11 -1
- package/models/investment-create.ts +27 -0
- package/models/investment-response.ts +31 -0
- package/models/investment-update.ts +24 -0
- package/models/{validation-error-loc-inner.ts → location-inner.ts} +2 -7
- package/models/measurement-type.ts +1 -6
- package/models/metric-costs-per-year-create.ts +1 -17
- package/models/metric-costs-per-year-response.ts +1 -18
- package/models/metric-costs-per-year-update.ts +1 -13
- package/models/metric-create.ts +3 -28
- package/models/metric-response.ts +3 -50
- package/models/metric-type.ts +1 -6
- package/models/metric-update.ts +3 -35
- package/models/objective-create.ts +1 -10
- package/models/objective-response.ts +1 -30
- package/models/objective-update.ts +1 -13
- package/models/objective-weight-create.ts +1 -9
- package/models/objective-weight-response.ts +1 -14
- package/models/objective-weight-update.ts +1 -8
- package/models/option-create.ts +39 -0
- package/models/option-response.ts +37 -0
- package/models/option-update.ts +25 -0
- package/models/validation-error.ts +3 -33
- package/models/value-framework-create.ts +1 -10
- package/models/value-framework-response.ts +1 -30
- package/models/value-framework-update.ts +1 -13
- package/package.json +4 -4
|
@@ -0,0 +1,607 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Asset Investment Planning
|
|
3
|
+
* API for Asset Investment Planning
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.2.0-dev3
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { ImpactAPIResponse } from '../models';
|
|
16
|
+
import type { ImpactCreate } from '../models';
|
|
17
|
+
import type { ImpactUpdate } from '../models';
|
|
18
|
+
import type { InvestmentCreate } from '../models';
|
|
19
|
+
import type { InvestmentResponse } from '../models';
|
|
20
|
+
import type { InvestmentUpdate } from '../models';
|
|
21
|
+
import type { OptionCreate } from '../models';
|
|
22
|
+
import type { OptionResponse } from '../models';
|
|
23
|
+
import type { OptionUpdate } from '../models';
|
|
24
|
+
/**
|
|
25
|
+
* InvestmentApi - axios parameter creator
|
|
26
|
+
*/
|
|
27
|
+
export declare const InvestmentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
|
+
/**
|
|
29
|
+
* Create a new impact under this option.
|
|
30
|
+
* @summary Create an impact for this option
|
|
31
|
+
* @param {string} optionId UUID of the option
|
|
32
|
+
* @param {string} investmentId UUID of the investment
|
|
33
|
+
* @param {ImpactCreate} impactCreate
|
|
34
|
+
* @param {*} [options] Override http request option.
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
createImpactForOption: (optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
|
+
/**
|
|
39
|
+
* Create a new option under this investment.
|
|
40
|
+
* @summary Create an option for this investment
|
|
41
|
+
* @param {string} investmentId UUID of the investment
|
|
42
|
+
* @param {OptionCreate} optionCreate
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
createOptionForInvestment: (investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
+
/**
|
|
48
|
+
* Delete an existing impact by its ID.
|
|
49
|
+
* @summary Delete an impact for this option
|
|
50
|
+
* @param {string} impactId UUID of the impact
|
|
51
|
+
* @param {string} optionId UUID of the option
|
|
52
|
+
* @param {string} investmentId UUID of the investment
|
|
53
|
+
* @param {*} [options] Override http request option.
|
|
54
|
+
* @throws {RequiredError}
|
|
55
|
+
*/
|
|
56
|
+
deleteImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
|
+
/**
|
|
58
|
+
* Delete an existing investment by its ID. Associated options are also deleted via cascade.
|
|
59
|
+
* @summary Delete an investment
|
|
60
|
+
* @param {string} investmentId UUID of the investment
|
|
61
|
+
* @param {*} [options] Override http request option.
|
|
62
|
+
* @throws {RequiredError}
|
|
63
|
+
*/
|
|
64
|
+
deleteInvestment: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
|
+
/**
|
|
66
|
+
* Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
|
|
67
|
+
* @summary Delete an option for this investment
|
|
68
|
+
* @param {string} optionId UUID of the option
|
|
69
|
+
* @param {string} investmentId UUID of the investment
|
|
70
|
+
* @param {*} [options] Override http request option.
|
|
71
|
+
* @throws {RequiredError}
|
|
72
|
+
*/
|
|
73
|
+
deleteOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
74
|
+
/**
|
|
75
|
+
* Retrieve a specific impact for the option.
|
|
76
|
+
* @summary Get an impact for this option
|
|
77
|
+
* @param {string} impactId UUID of the impact
|
|
78
|
+
* @param {string} optionId UUID of the option
|
|
79
|
+
* @param {string} investmentId UUID of the investment
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
*/
|
|
83
|
+
getImpactForOption: (impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
84
|
+
/**
|
|
85
|
+
* Retrieve a paginated list of all impacts for a specific option.
|
|
86
|
+
* @summary List impacts for this option
|
|
87
|
+
* @param {string} optionId UUID of the option
|
|
88
|
+
* @param {string} investmentId UUID of the investment
|
|
89
|
+
* @param {number} [offset] Number of records to skip
|
|
90
|
+
* @param {number} [limit] Max number of records to return
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
getImpactsForOption: (optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
95
|
+
/**
|
|
96
|
+
* Retrieve a single investment by its ID.
|
|
97
|
+
* @summary Get an investment by ID
|
|
98
|
+
* @param {string} investmentId UUID of the investment
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
getInvestmentById: (investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
103
|
+
/**
|
|
104
|
+
* Retrieve a paginated list of all investments.
|
|
105
|
+
* @summary List investments
|
|
106
|
+
* @param {number} [offset] Number of records to skip
|
|
107
|
+
* @param {number} [limit] Max number of records to return
|
|
108
|
+
* @param {*} [options] Override http request option.
|
|
109
|
+
* @throws {RequiredError}
|
|
110
|
+
*/
|
|
111
|
+
getInvestments: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
112
|
+
/**
|
|
113
|
+
* Retrieve a specific option for the investment.
|
|
114
|
+
* @summary Get an option for this investment
|
|
115
|
+
* @param {string} optionId UUID of the option
|
|
116
|
+
* @param {string} investmentId UUID of the investment
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
getOptionForInvestment: (optionId: string, investmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
121
|
+
/**
|
|
122
|
+
* Retrieve a paginated list of all options for a specific investment.
|
|
123
|
+
* @summary List options for this investment
|
|
124
|
+
* @param {string} investmentId UUID of the investment
|
|
125
|
+
* @param {number} [offset] Number of records to skip
|
|
126
|
+
* @param {number} [limit] Max number of records to return
|
|
127
|
+
* @param {*} [options] Override http request option.
|
|
128
|
+
* @throws {RequiredError}
|
|
129
|
+
*/
|
|
130
|
+
getOptionsForInvestment: (investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
131
|
+
/**
|
|
132
|
+
* Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
133
|
+
* @summary Partially update an impact for this option
|
|
134
|
+
* @param {string} impactId UUID of the impact
|
|
135
|
+
* @param {string} optionId UUID of the option
|
|
136
|
+
* @param {string} investmentId UUID of the investment
|
|
137
|
+
* @param {ImpactUpdate} impactUpdate
|
|
138
|
+
* @param {*} [options] Override http request option.
|
|
139
|
+
* @throws {RequiredError}
|
|
140
|
+
*/
|
|
141
|
+
patchImpactForOption: (impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
142
|
+
/**
|
|
143
|
+
* Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
144
|
+
* @summary Partially update an investment
|
|
145
|
+
* @param {string} investmentId UUID of the investment
|
|
146
|
+
* @param {InvestmentUpdate} investmentUpdate
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
*/
|
|
150
|
+
patchInvestment: (investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
151
|
+
/**
|
|
152
|
+
* Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
153
|
+
* @summary Partially update an option for this investment
|
|
154
|
+
* @param {string} optionId UUID of the option
|
|
155
|
+
* @param {string} investmentId UUID of the investment
|
|
156
|
+
* @param {OptionUpdate} optionUpdate
|
|
157
|
+
* @param {*} [options] Override http request option.
|
|
158
|
+
* @throws {RequiredError}
|
|
159
|
+
*/
|
|
160
|
+
patchOptionForInvestment: (optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
161
|
+
/**
|
|
162
|
+
* Create a new investment.
|
|
163
|
+
* @summary Create an investment
|
|
164
|
+
* @param {InvestmentCreate} investmentCreate
|
|
165
|
+
* @param {*} [options] Override http request option.
|
|
166
|
+
* @throws {RequiredError}
|
|
167
|
+
*/
|
|
168
|
+
postInvestment: (investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
169
|
+
};
|
|
170
|
+
/**
|
|
171
|
+
* InvestmentApi - functional programming interface
|
|
172
|
+
*/
|
|
173
|
+
export declare const InvestmentApiFp: (configuration?: Configuration) => {
|
|
174
|
+
/**
|
|
175
|
+
* Create a new impact under this option.
|
|
176
|
+
* @summary Create an impact for this option
|
|
177
|
+
* @param {string} optionId UUID of the option
|
|
178
|
+
* @param {string} investmentId UUID of the investment
|
|
179
|
+
* @param {ImpactCreate} impactCreate
|
|
180
|
+
* @param {*} [options] Override http request option.
|
|
181
|
+
* @throws {RequiredError}
|
|
182
|
+
*/
|
|
183
|
+
createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
|
|
184
|
+
/**
|
|
185
|
+
* Create a new option under this investment.
|
|
186
|
+
* @summary Create an option for this investment
|
|
187
|
+
* @param {string} investmentId UUID of the investment
|
|
188
|
+
* @param {OptionCreate} optionCreate
|
|
189
|
+
* @param {*} [options] Override http request option.
|
|
190
|
+
* @throws {RequiredError}
|
|
191
|
+
*/
|
|
192
|
+
createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
|
|
193
|
+
/**
|
|
194
|
+
* Delete an existing impact by its ID.
|
|
195
|
+
* @summary Delete an impact for this option
|
|
196
|
+
* @param {string} impactId UUID of the impact
|
|
197
|
+
* @param {string} optionId UUID of the option
|
|
198
|
+
* @param {string} investmentId UUID of the investment
|
|
199
|
+
* @param {*} [options] Override http request option.
|
|
200
|
+
* @throws {RequiredError}
|
|
201
|
+
*/
|
|
202
|
+
deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
203
|
+
/**
|
|
204
|
+
* Delete an existing investment by its ID. Associated options are also deleted via cascade.
|
|
205
|
+
* @summary Delete an investment
|
|
206
|
+
* @param {string} investmentId UUID of the investment
|
|
207
|
+
* @param {*} [options] Override http request option.
|
|
208
|
+
* @throws {RequiredError}
|
|
209
|
+
*/
|
|
210
|
+
deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
211
|
+
/**
|
|
212
|
+
* Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
|
|
213
|
+
* @summary Delete an option for this investment
|
|
214
|
+
* @param {string} optionId UUID of the option
|
|
215
|
+
* @param {string} investmentId UUID of the investment
|
|
216
|
+
* @param {*} [options] Override http request option.
|
|
217
|
+
* @throws {RequiredError}
|
|
218
|
+
*/
|
|
219
|
+
deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
220
|
+
/**
|
|
221
|
+
* Retrieve a specific impact for the option.
|
|
222
|
+
* @summary Get an impact for this option
|
|
223
|
+
* @param {string} impactId UUID of the impact
|
|
224
|
+
* @param {string} optionId UUID of the option
|
|
225
|
+
* @param {string} investmentId UUID of the investment
|
|
226
|
+
* @param {*} [options] Override http request option.
|
|
227
|
+
* @throws {RequiredError}
|
|
228
|
+
*/
|
|
229
|
+
getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
|
|
230
|
+
/**
|
|
231
|
+
* Retrieve a paginated list of all impacts for a specific option.
|
|
232
|
+
* @summary List impacts for this option
|
|
233
|
+
* @param {string} optionId UUID of the option
|
|
234
|
+
* @param {string} investmentId UUID of the investment
|
|
235
|
+
* @param {number} [offset] Number of records to skip
|
|
236
|
+
* @param {number} [limit] Max number of records to return
|
|
237
|
+
* @param {*} [options] Override http request option.
|
|
238
|
+
* @throws {RequiredError}
|
|
239
|
+
*/
|
|
240
|
+
getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ImpactAPIResponse>>>;
|
|
241
|
+
/**
|
|
242
|
+
* Retrieve a single investment by its ID.
|
|
243
|
+
* @summary Get an investment by ID
|
|
244
|
+
* @param {string} investmentId UUID of the investment
|
|
245
|
+
* @param {*} [options] Override http request option.
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
getInvestmentById(investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
|
|
249
|
+
/**
|
|
250
|
+
* Retrieve a paginated list of all investments.
|
|
251
|
+
* @summary List investments
|
|
252
|
+
* @param {number} [offset] Number of records to skip
|
|
253
|
+
* @param {number} [limit] Max number of records to return
|
|
254
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
*/
|
|
257
|
+
getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvestmentResponse>>>;
|
|
258
|
+
/**
|
|
259
|
+
* Retrieve a specific option for the investment.
|
|
260
|
+
* @summary Get an option for this investment
|
|
261
|
+
* @param {string} optionId UUID of the option
|
|
262
|
+
* @param {string} investmentId UUID of the investment
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
|
|
267
|
+
/**
|
|
268
|
+
* Retrieve a paginated list of all options for a specific investment.
|
|
269
|
+
* @summary List options for this investment
|
|
270
|
+
* @param {string} investmentId UUID of the investment
|
|
271
|
+
* @param {number} [offset] Number of records to skip
|
|
272
|
+
* @param {number} [limit] Max number of records to return
|
|
273
|
+
* @param {*} [options] Override http request option.
|
|
274
|
+
* @throws {RequiredError}
|
|
275
|
+
*/
|
|
276
|
+
getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OptionResponse>>>;
|
|
277
|
+
/**
|
|
278
|
+
* Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
279
|
+
* @summary Partially update an impact for this option
|
|
280
|
+
* @param {string} impactId UUID of the impact
|
|
281
|
+
* @param {string} optionId UUID of the option
|
|
282
|
+
* @param {string} investmentId UUID of the investment
|
|
283
|
+
* @param {ImpactUpdate} impactUpdate
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
*/
|
|
287
|
+
patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImpactAPIResponse>>;
|
|
288
|
+
/**
|
|
289
|
+
* Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
290
|
+
* @summary Partially update an investment
|
|
291
|
+
* @param {string} investmentId UUID of the investment
|
|
292
|
+
* @param {InvestmentUpdate} investmentUpdate
|
|
293
|
+
* @param {*} [options] Override http request option.
|
|
294
|
+
* @throws {RequiredError}
|
|
295
|
+
*/
|
|
296
|
+
patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
|
|
297
|
+
/**
|
|
298
|
+
* Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
299
|
+
* @summary Partially update an option for this investment
|
|
300
|
+
* @param {string} optionId UUID of the option
|
|
301
|
+
* @param {string} investmentId UUID of the investment
|
|
302
|
+
* @param {OptionUpdate} optionUpdate
|
|
303
|
+
* @param {*} [options] Override http request option.
|
|
304
|
+
* @throws {RequiredError}
|
|
305
|
+
*/
|
|
306
|
+
patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OptionResponse>>;
|
|
307
|
+
/**
|
|
308
|
+
* Create a new investment.
|
|
309
|
+
* @summary Create an investment
|
|
310
|
+
* @param {InvestmentCreate} investmentCreate
|
|
311
|
+
* @param {*} [options] Override http request option.
|
|
312
|
+
* @throws {RequiredError}
|
|
313
|
+
*/
|
|
314
|
+
postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvestmentResponse>>;
|
|
315
|
+
};
|
|
316
|
+
/**
|
|
317
|
+
* InvestmentApi - factory interface
|
|
318
|
+
*/
|
|
319
|
+
export declare const InvestmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
320
|
+
/**
|
|
321
|
+
* Create a new impact under this option.
|
|
322
|
+
* @summary Create an impact for this option
|
|
323
|
+
* @param {string} optionId UUID of the option
|
|
324
|
+
* @param {string} investmentId UUID of the investment
|
|
325
|
+
* @param {ImpactCreate} impactCreate
|
|
326
|
+
* @param {*} [options] Override http request option.
|
|
327
|
+
* @throws {RequiredError}
|
|
328
|
+
*/
|
|
329
|
+
createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
|
|
330
|
+
/**
|
|
331
|
+
* Create a new option under this investment.
|
|
332
|
+
* @summary Create an option for this investment
|
|
333
|
+
* @param {string} investmentId UUID of the investment
|
|
334
|
+
* @param {OptionCreate} optionCreate
|
|
335
|
+
* @param {*} [options] Override http request option.
|
|
336
|
+
* @throws {RequiredError}
|
|
337
|
+
*/
|
|
338
|
+
createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
|
|
339
|
+
/**
|
|
340
|
+
* Delete an existing impact by its ID.
|
|
341
|
+
* @summary Delete an impact for this option
|
|
342
|
+
* @param {string} impactId UUID of the impact
|
|
343
|
+
* @param {string} optionId UUID of the option
|
|
344
|
+
* @param {string} investmentId UUID of the investment
|
|
345
|
+
* @param {*} [options] Override http request option.
|
|
346
|
+
* @throws {RequiredError}
|
|
347
|
+
*/
|
|
348
|
+
deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
349
|
+
/**
|
|
350
|
+
* Delete an existing investment by its ID. Associated options are also deleted via cascade.
|
|
351
|
+
* @summary Delete an investment
|
|
352
|
+
* @param {string} investmentId UUID of the investment
|
|
353
|
+
* @param {*} [options] Override http request option.
|
|
354
|
+
* @throws {RequiredError}
|
|
355
|
+
*/
|
|
356
|
+
deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
357
|
+
/**
|
|
358
|
+
* Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
|
|
359
|
+
* @summary Delete an option for this investment
|
|
360
|
+
* @param {string} optionId UUID of the option
|
|
361
|
+
* @param {string} investmentId UUID of the investment
|
|
362
|
+
* @param {*} [options] Override http request option.
|
|
363
|
+
* @throws {RequiredError}
|
|
364
|
+
*/
|
|
365
|
+
deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
366
|
+
/**
|
|
367
|
+
* Retrieve a specific impact for the option.
|
|
368
|
+
* @summary Get an impact for this option
|
|
369
|
+
* @param {string} impactId UUID of the impact
|
|
370
|
+
* @param {string} optionId UUID of the option
|
|
371
|
+
* @param {string} investmentId UUID of the investment
|
|
372
|
+
* @param {*} [options] Override http request option.
|
|
373
|
+
* @throws {RequiredError}
|
|
374
|
+
*/
|
|
375
|
+
getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
|
|
376
|
+
/**
|
|
377
|
+
* Retrieve a paginated list of all impacts for a specific option.
|
|
378
|
+
* @summary List impacts for this option
|
|
379
|
+
* @param {string} optionId UUID of the option
|
|
380
|
+
* @param {string} investmentId UUID of the investment
|
|
381
|
+
* @param {number} [offset] Number of records to skip
|
|
382
|
+
* @param {number} [limit] Max number of records to return
|
|
383
|
+
* @param {*} [options] Override http request option.
|
|
384
|
+
* @throws {RequiredError}
|
|
385
|
+
*/
|
|
386
|
+
getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<ImpactAPIResponse>>;
|
|
387
|
+
/**
|
|
388
|
+
* Retrieve a single investment by its ID.
|
|
389
|
+
* @summary Get an investment by ID
|
|
390
|
+
* @param {string} investmentId UUID of the investment
|
|
391
|
+
* @param {*} [options] Override http request option.
|
|
392
|
+
* @throws {RequiredError}
|
|
393
|
+
*/
|
|
394
|
+
getInvestmentById(investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
|
|
395
|
+
/**
|
|
396
|
+
* Retrieve a paginated list of all investments.
|
|
397
|
+
* @summary List investments
|
|
398
|
+
* @param {number} [offset] Number of records to skip
|
|
399
|
+
* @param {number} [limit] Max number of records to return
|
|
400
|
+
* @param {*} [options] Override http request option.
|
|
401
|
+
* @throws {RequiredError}
|
|
402
|
+
*/
|
|
403
|
+
getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<InvestmentResponse>>;
|
|
404
|
+
/**
|
|
405
|
+
* Retrieve a specific option for the investment.
|
|
406
|
+
* @summary Get an option for this investment
|
|
407
|
+
* @param {string} optionId UUID of the option
|
|
408
|
+
* @param {string} investmentId UUID of the investment
|
|
409
|
+
* @param {*} [options] Override http request option.
|
|
410
|
+
* @throws {RequiredError}
|
|
411
|
+
*/
|
|
412
|
+
getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
|
|
413
|
+
/**
|
|
414
|
+
* Retrieve a paginated list of all options for a specific investment.
|
|
415
|
+
* @summary List options for this investment
|
|
416
|
+
* @param {string} investmentId UUID of the investment
|
|
417
|
+
* @param {number} [offset] Number of records to skip
|
|
418
|
+
* @param {number} [limit] Max number of records to return
|
|
419
|
+
* @param {*} [options] Override http request option.
|
|
420
|
+
* @throws {RequiredError}
|
|
421
|
+
*/
|
|
422
|
+
getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<OptionResponse>>;
|
|
423
|
+
/**
|
|
424
|
+
* Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
425
|
+
* @summary Partially update an impact for this option
|
|
426
|
+
* @param {string} impactId UUID of the impact
|
|
427
|
+
* @param {string} optionId UUID of the option
|
|
428
|
+
* @param {string} investmentId UUID of the investment
|
|
429
|
+
* @param {ImpactUpdate} impactUpdate
|
|
430
|
+
* @param {*} [options] Override http request option.
|
|
431
|
+
* @throws {RequiredError}
|
|
432
|
+
*/
|
|
433
|
+
patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): AxiosPromise<ImpactAPIResponse>;
|
|
434
|
+
/**
|
|
435
|
+
* Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
436
|
+
* @summary Partially update an investment
|
|
437
|
+
* @param {string} investmentId UUID of the investment
|
|
438
|
+
* @param {InvestmentUpdate} investmentUpdate
|
|
439
|
+
* @param {*} [options] Override http request option.
|
|
440
|
+
* @throws {RequiredError}
|
|
441
|
+
*/
|
|
442
|
+
patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
|
|
443
|
+
/**
|
|
444
|
+
* Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
445
|
+
* @summary Partially update an option for this investment
|
|
446
|
+
* @param {string} optionId UUID of the option
|
|
447
|
+
* @param {string} investmentId UUID of the investment
|
|
448
|
+
* @param {OptionUpdate} optionUpdate
|
|
449
|
+
* @param {*} [options] Override http request option.
|
|
450
|
+
* @throws {RequiredError}
|
|
451
|
+
*/
|
|
452
|
+
patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): AxiosPromise<OptionResponse>;
|
|
453
|
+
/**
|
|
454
|
+
* Create a new investment.
|
|
455
|
+
* @summary Create an investment
|
|
456
|
+
* @param {InvestmentCreate} investmentCreate
|
|
457
|
+
* @param {*} [options] Override http request option.
|
|
458
|
+
* @throws {RequiredError}
|
|
459
|
+
*/
|
|
460
|
+
postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): AxiosPromise<InvestmentResponse>;
|
|
461
|
+
};
|
|
462
|
+
/**
|
|
463
|
+
* InvestmentApi - object-oriented interface
|
|
464
|
+
*/
|
|
465
|
+
export declare class InvestmentApi extends BaseAPI {
|
|
466
|
+
/**
|
|
467
|
+
* Create a new impact under this option.
|
|
468
|
+
* @summary Create an impact for this option
|
|
469
|
+
* @param {string} optionId UUID of the option
|
|
470
|
+
* @param {string} investmentId UUID of the investment
|
|
471
|
+
* @param {ImpactCreate} impactCreate
|
|
472
|
+
* @param {*} [options] Override http request option.
|
|
473
|
+
* @throws {RequiredError}
|
|
474
|
+
*/
|
|
475
|
+
createImpactForOption(optionId: string, investmentId: string, impactCreate: ImpactCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
|
|
476
|
+
/**
|
|
477
|
+
* Create a new option under this investment.
|
|
478
|
+
* @summary Create an option for this investment
|
|
479
|
+
* @param {string} investmentId UUID of the investment
|
|
480
|
+
* @param {OptionCreate} optionCreate
|
|
481
|
+
* @param {*} [options] Override http request option.
|
|
482
|
+
* @throws {RequiredError}
|
|
483
|
+
*/
|
|
484
|
+
createOptionForInvestment(investmentId: string, optionCreate: OptionCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
|
|
485
|
+
/**
|
|
486
|
+
* Delete an existing impact by its ID.
|
|
487
|
+
* @summary Delete an impact for this option
|
|
488
|
+
* @param {string} impactId UUID of the impact
|
|
489
|
+
* @param {string} optionId UUID of the option
|
|
490
|
+
* @param {string} investmentId UUID of the investment
|
|
491
|
+
* @param {*} [options] Override http request option.
|
|
492
|
+
* @throws {RequiredError}
|
|
493
|
+
*/
|
|
494
|
+
deleteImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
495
|
+
/**
|
|
496
|
+
* Delete an existing investment by its ID. Associated options are also deleted via cascade.
|
|
497
|
+
* @summary Delete an investment
|
|
498
|
+
* @param {string} investmentId UUID of the investment
|
|
499
|
+
* @param {*} [options] Override http request option.
|
|
500
|
+
* @throws {RequiredError}
|
|
501
|
+
*/
|
|
502
|
+
deleteInvestment(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
503
|
+
/**
|
|
504
|
+
* Delete an existing option by its ID. Associated phases and impacts are also deleted via cascade.
|
|
505
|
+
* @summary Delete an option for this investment
|
|
506
|
+
* @param {string} optionId UUID of the option
|
|
507
|
+
* @param {string} investmentId UUID of the investment
|
|
508
|
+
* @param {*} [options] Override http request option.
|
|
509
|
+
* @throws {RequiredError}
|
|
510
|
+
*/
|
|
511
|
+
deleteOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
512
|
+
/**
|
|
513
|
+
* Retrieve a specific impact for the option.
|
|
514
|
+
* @summary Get an impact for this option
|
|
515
|
+
* @param {string} impactId UUID of the impact
|
|
516
|
+
* @param {string} optionId UUID of the option
|
|
517
|
+
* @param {string} investmentId UUID of the investment
|
|
518
|
+
* @param {*} [options] Override http request option.
|
|
519
|
+
* @throws {RequiredError}
|
|
520
|
+
*/
|
|
521
|
+
getImpactForOption(impactId: string, optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
|
|
522
|
+
/**
|
|
523
|
+
* Retrieve a paginated list of all impacts for a specific option.
|
|
524
|
+
* @summary List impacts for this option
|
|
525
|
+
* @param {string} optionId UUID of the option
|
|
526
|
+
* @param {string} investmentId UUID of the investment
|
|
527
|
+
* @param {number} [offset] Number of records to skip
|
|
528
|
+
* @param {number} [limit] Max number of records to return
|
|
529
|
+
* @param {*} [options] Override http request option.
|
|
530
|
+
* @throws {RequiredError}
|
|
531
|
+
*/
|
|
532
|
+
getImpactsForOption(optionId: string, investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse[], any, {}>>;
|
|
533
|
+
/**
|
|
534
|
+
* Retrieve a single investment by its ID.
|
|
535
|
+
* @summary Get an investment by ID
|
|
536
|
+
* @param {string} investmentId UUID of the investment
|
|
537
|
+
* @param {*} [options] Override http request option.
|
|
538
|
+
* @throws {RequiredError}
|
|
539
|
+
*/
|
|
540
|
+
getInvestmentById(investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
|
|
541
|
+
/**
|
|
542
|
+
* Retrieve a paginated list of all investments.
|
|
543
|
+
* @summary List investments
|
|
544
|
+
* @param {number} [offset] Number of records to skip
|
|
545
|
+
* @param {number} [limit] Max number of records to return
|
|
546
|
+
* @param {*} [options] Override http request option.
|
|
547
|
+
* @throws {RequiredError}
|
|
548
|
+
*/
|
|
549
|
+
getInvestments(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse[], any, {}>>;
|
|
550
|
+
/**
|
|
551
|
+
* Retrieve a specific option for the investment.
|
|
552
|
+
* @summary Get an option for this investment
|
|
553
|
+
* @param {string} optionId UUID of the option
|
|
554
|
+
* @param {string} investmentId UUID of the investment
|
|
555
|
+
* @param {*} [options] Override http request option.
|
|
556
|
+
* @throws {RequiredError}
|
|
557
|
+
*/
|
|
558
|
+
getOptionForInvestment(optionId: string, investmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
|
|
559
|
+
/**
|
|
560
|
+
* Retrieve a paginated list of all options for a specific investment.
|
|
561
|
+
* @summary List options for this investment
|
|
562
|
+
* @param {string} investmentId UUID of the investment
|
|
563
|
+
* @param {number} [offset] Number of records to skip
|
|
564
|
+
* @param {number} [limit] Max number of records to return
|
|
565
|
+
* @param {*} [options] Override http request option.
|
|
566
|
+
* @throws {RequiredError}
|
|
567
|
+
*/
|
|
568
|
+
getOptionsForInvestment(investmentId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse[], any, {}>>;
|
|
569
|
+
/**
|
|
570
|
+
* Update one or more fields of an existing impact. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
571
|
+
* @summary Partially update an impact for this option
|
|
572
|
+
* @param {string} impactId UUID of the impact
|
|
573
|
+
* @param {string} optionId UUID of the option
|
|
574
|
+
* @param {string} investmentId UUID of the investment
|
|
575
|
+
* @param {ImpactUpdate} impactUpdate
|
|
576
|
+
* @param {*} [options] Override http request option.
|
|
577
|
+
* @throws {RequiredError}
|
|
578
|
+
*/
|
|
579
|
+
patchImpactForOption(impactId: string, optionId: string, investmentId: string, impactUpdate: ImpactUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImpactAPIResponse, any, {}>>;
|
|
580
|
+
/**
|
|
581
|
+
* Update one or more fields of an existing investment. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
582
|
+
* @summary Partially update an investment
|
|
583
|
+
* @param {string} investmentId UUID of the investment
|
|
584
|
+
* @param {InvestmentUpdate} investmentUpdate
|
|
585
|
+
* @param {*} [options] Override http request option.
|
|
586
|
+
* @throws {RequiredError}
|
|
587
|
+
*/
|
|
588
|
+
patchInvestment(investmentId: string, investmentUpdate: InvestmentUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
|
|
589
|
+
/**
|
|
590
|
+
* Update one or more fields of an existing option. Only the fields included in the request body will be modified; omitted fields remain unchanged.
|
|
591
|
+
* @summary Partially update an option for this investment
|
|
592
|
+
* @param {string} optionId UUID of the option
|
|
593
|
+
* @param {string} investmentId UUID of the investment
|
|
594
|
+
* @param {OptionUpdate} optionUpdate
|
|
595
|
+
* @param {*} [options] Override http request option.
|
|
596
|
+
* @throws {RequiredError}
|
|
597
|
+
*/
|
|
598
|
+
patchOptionForInvestment(optionId: string, investmentId: string, optionUpdate: OptionUpdate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OptionResponse, any, {}>>;
|
|
599
|
+
/**
|
|
600
|
+
* Create a new investment.
|
|
601
|
+
* @summary Create an investment
|
|
602
|
+
* @param {InvestmentCreate} investmentCreate
|
|
603
|
+
* @param {*} [options] Override http request option.
|
|
604
|
+
* @throws {RequiredError}
|
|
605
|
+
*/
|
|
606
|
+
postInvestment(investmentCreate: InvestmentCreate, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InvestmentResponse, any, {}>>;
|
|
607
|
+
}
|