@cosmotech/aip-client 0.2.0-dev → 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.
Files changed (290) hide show
  1. package/README.md +141 -4
  2. package/api/default-api.ts +8 -15
  3. package/api/impact-api.ts +507 -0
  4. package/api/investment-api.ts +1308 -0
  5. package/api/metric-api.ts +185 -164
  6. package/api/metric-costs-api.ts +144 -0
  7. package/api/metric-costs-per-year-api.ts +200 -200
  8. package/api/objective-api.ts +538 -44
  9. package/api/objective-weight-api.ts +190 -190
  10. package/api/objective-weights-api.ts +144 -0
  11. package/api/option-api.ts +925 -0
  12. package/api/value-framework-api.ts +1223 -109
  13. package/api/value-framework-costs-api.ts +239 -0
  14. package/api/value-framework-weights-api.ts +144 -0
  15. package/api.ts +8 -1
  16. package/base.ts +1 -25
  17. package/common.ts +20 -43
  18. package/configuration.ts +31 -20
  19. package/dist/api/default-api.d.ts +62 -0
  20. package/dist/api/default-api.js +122 -0
  21. package/dist/api/impact-api.d.ts +245 -0
  22. package/dist/api/impact-api.js +493 -0
  23. package/dist/api/investment-api.d.ts +607 -0
  24. package/dist/api/investment-api.js +1248 -0
  25. package/dist/api/metric-api.d.ts +225 -0
  26. package/dist/api/metric-api.js +458 -0
  27. package/dist/api/metric-costs-api.d.ts +75 -0
  28. package/dist/api/metric-costs-api.js +146 -0
  29. package/dist/api/metric-costs-per-year-api.d.ts +237 -0
  30. package/dist/api/metric-costs-per-year-api.js +479 -0
  31. package/dist/api/objective-api.d.ts +437 -0
  32. package/dist/api/objective-api.js +901 -0
  33. package/dist/api/objective-weight-api.d.ts +225 -0
  34. package/dist/api/objective-weight-api.js +458 -0
  35. package/dist/api/objective-weights-api.d.ts +75 -0
  36. package/dist/api/objective-weights-api.js +146 -0
  37. package/dist/api/option-api.d.ts +436 -0
  38. package/dist/api/option-api.js +888 -0
  39. package/dist/api/value-framework-api.d.ts +723 -0
  40. package/dist/api/value-framework-api.js +1490 -0
  41. package/dist/api/value-framework-costs-api.d.ts +119 -0
  42. package/dist/api/value-framework-costs-api.js +236 -0
  43. package/dist/api/value-framework-weights-api.d.ts +75 -0
  44. package/dist/api/value-framework-weights-api.js +146 -0
  45. package/dist/api.d.ts +24 -0
  46. package/dist/api.js +42 -0
  47. package/dist/base.d.ts +42 -0
  48. package/dist/base.js +46 -0
  49. package/dist/common.d.ts +34 -0
  50. package/dist/common.js +139 -0
  51. package/dist/configuration.d.ts +98 -0
  52. package/dist/configuration.js +44 -0
  53. package/dist/esm/api/default-api.d.ts +62 -0
  54. package/dist/esm/api/default-api.js +115 -0
  55. package/dist/esm/api/impact-api.d.ts +245 -0
  56. package/dist/esm/api/impact-api.js +486 -0
  57. package/dist/esm/api/investment-api.d.ts +607 -0
  58. package/dist/esm/api/investment-api.js +1241 -0
  59. package/dist/esm/api/metric-api.d.ts +225 -0
  60. package/dist/esm/api/metric-api.js +451 -0
  61. package/dist/esm/api/metric-costs-api.d.ts +75 -0
  62. package/dist/esm/api/metric-costs-api.js +139 -0
  63. package/dist/esm/api/metric-costs-per-year-api.d.ts +237 -0
  64. package/dist/esm/api/metric-costs-per-year-api.js +472 -0
  65. package/dist/esm/api/objective-api.d.ts +437 -0
  66. package/dist/esm/api/objective-api.js +894 -0
  67. package/dist/esm/api/objective-weight-api.d.ts +225 -0
  68. package/dist/esm/api/objective-weight-api.js +451 -0
  69. package/dist/esm/api/objective-weights-api.d.ts +75 -0
  70. package/dist/esm/api/objective-weights-api.js +139 -0
  71. package/dist/esm/api/option-api.d.ts +436 -0
  72. package/dist/esm/api/option-api.js +881 -0
  73. package/dist/esm/api/value-framework-api.d.ts +723 -0
  74. package/dist/esm/api/value-framework-api.js +1483 -0
  75. package/dist/esm/api/value-framework-costs-api.d.ts +119 -0
  76. package/dist/esm/api/value-framework-costs-api.js +229 -0
  77. package/dist/esm/api/value-framework-weights-api.d.ts +75 -0
  78. package/dist/esm/api/value-framework-weights-api.js +139 -0
  79. package/dist/esm/api.d.ts +24 -0
  80. package/dist/esm/api.js +26 -0
  81. package/dist/esm/base.d.ts +42 -0
  82. package/dist/esm/base.js +41 -0
  83. package/dist/esm/common.d.ts +34 -0
  84. package/dist/esm/common.js +126 -0
  85. package/dist/esm/configuration.d.ts +98 -0
  86. package/dist/esm/configuration.js +40 -0
  87. package/dist/esm/index.d.ts +14 -0
  88. package/dist/esm/index.js +16 -0
  89. package/dist/esm/models/evolution-type.d.ts +16 -0
  90. package/dist/esm/models/evolution-type.js +17 -0
  91. package/dist/esm/models/httpvalidation-error.d.ts +15 -0
  92. package/dist/esm/models/httpvalidation-error.js +14 -0
  93. package/dist/esm/models/impact-apiresponse.d.ts +33 -0
  94. package/dist/esm/models/impact-apiresponse.js +14 -0
  95. package/dist/esm/models/impact-create.d.ts +37 -0
  96. package/dist/esm/models/impact-create.js +14 -0
  97. package/dist/esm/models/impact-update.d.ts +22 -0
  98. package/dist/esm/models/impact-update.js +14 -0
  99. package/dist/esm/models/index.d.ts +30 -0
  100. package/dist/esm/models/index.js +30 -0
  101. package/dist/esm/models/investment-create.d.ts +21 -0
  102. package/dist/esm/models/investment-create.js +14 -0
  103. package/dist/esm/models/investment-response.d.ts +25 -0
  104. package/dist/esm/models/investment-response.js +14 -0
  105. package/dist/esm/models/investment-update.d.ts +18 -0
  106. package/dist/esm/models/investment-update.js +14 -0
  107. package/dist/esm/models/location-inner.d.ts +13 -0
  108. package/dist/esm/models/location-inner.js +14 -0
  109. package/dist/esm/models/measurement-type.d.ts +16 -0
  110. package/dist/esm/models/measurement-type.js +17 -0
  111. package/dist/esm/models/metric-costs-per-year-create.d.ts +32 -0
  112. package/dist/esm/models/metric-costs-per-year-create.js +14 -0
  113. package/dist/esm/models/metric-costs-per-year-response.d.ts +37 -0
  114. package/dist/esm/models/metric-costs-per-year-response.js +14 -0
  115. package/dist/esm/models/metric-costs-per-year-update.d.ts +18 -0
  116. package/dist/esm/models/metric-costs-per-year-update.js +14 -0
  117. package/dist/esm/models/metric-create.d.ts +43 -0
  118. package/dist/esm/models/metric-create.js +14 -0
  119. package/dist/esm/models/metric-response.d.ts +45 -0
  120. package/dist/esm/models/metric-response.js +14 -0
  121. package/dist/esm/models/metric-type.d.ts +17 -0
  122. package/dist/esm/models/metric-type.js +18 -0
  123. package/dist/esm/models/metric-update.d.ts +24 -0
  124. package/dist/esm/models/metric-update.js +14 -0
  125. package/dist/esm/models/objective-create.d.ts +21 -0
  126. package/dist/esm/models/objective-create.js +14 -0
  127. package/dist/esm/models/objective-response.d.ts +25 -0
  128. package/dist/esm/models/objective-response.js +14 -0
  129. package/dist/esm/models/objective-update.d.ts +18 -0
  130. package/dist/esm/models/objective-update.js +14 -0
  131. package/dist/esm/models/objective-weight-create.d.ts +28 -0
  132. package/dist/esm/models/objective-weight-create.js +14 -0
  133. package/dist/esm/models/objective-weight-response.d.ts +29 -0
  134. package/dist/esm/models/objective-weight-response.js +14 -0
  135. package/dist/esm/models/objective-weight-update.d.ts +17 -0
  136. package/dist/esm/models/objective-weight-update.js +14 -0
  137. package/dist/esm/models/option-create.d.ts +33 -0
  138. package/dist/esm/models/option-create.js +14 -0
  139. package/dist/esm/models/option-response.d.ts +31 -0
  140. package/dist/esm/models/option-response.js +14 -0
  141. package/dist/esm/models/option-update.d.ts +19 -0
  142. package/dist/esm/models/option-update.js +14 -0
  143. package/dist/esm/models/validation-error.d.ts +19 -0
  144. package/dist/esm/models/validation-error.js +14 -0
  145. package/dist/esm/models/value-framework-create.d.ts +21 -0
  146. package/dist/esm/models/value-framework-create.js +14 -0
  147. package/dist/esm/models/value-framework-response.d.ts +25 -0
  148. package/dist/esm/models/value-framework-response.js +14 -0
  149. package/dist/esm/models/value-framework-update.d.ts +18 -0
  150. package/dist/esm/models/value-framework-update.js +14 -0
  151. package/dist/index.d.ts +14 -0
  152. package/dist/index.js +32 -0
  153. package/dist/models/evolution-type.d.ts +16 -0
  154. package/dist/models/evolution-type.js +20 -0
  155. package/dist/models/httpvalidation-error.d.ts +15 -0
  156. package/dist/models/httpvalidation-error.js +15 -0
  157. package/dist/models/impact-apiresponse.d.ts +33 -0
  158. package/dist/models/impact-apiresponse.js +15 -0
  159. package/dist/models/impact-create.d.ts +37 -0
  160. package/dist/models/impact-create.js +15 -0
  161. package/dist/models/impact-update.d.ts +22 -0
  162. package/dist/models/impact-update.js +15 -0
  163. package/dist/models/index.d.ts +30 -0
  164. package/dist/models/index.js +46 -0
  165. package/dist/models/investment-create.d.ts +21 -0
  166. package/dist/models/investment-create.js +15 -0
  167. package/dist/models/investment-response.d.ts +25 -0
  168. package/dist/models/investment-response.js +15 -0
  169. package/dist/models/investment-update.d.ts +18 -0
  170. package/dist/models/investment-update.js +15 -0
  171. package/dist/models/location-inner.d.ts +13 -0
  172. package/dist/models/location-inner.js +15 -0
  173. package/dist/models/measurement-type.d.ts +16 -0
  174. package/dist/models/measurement-type.js +20 -0
  175. package/dist/models/metric-costs-per-year-create.d.ts +32 -0
  176. package/dist/models/metric-costs-per-year-create.js +15 -0
  177. package/dist/models/metric-costs-per-year-response.d.ts +37 -0
  178. package/dist/models/metric-costs-per-year-response.js +15 -0
  179. package/dist/models/metric-costs-per-year-update.d.ts +18 -0
  180. package/dist/models/metric-costs-per-year-update.js +15 -0
  181. package/dist/models/metric-create.d.ts +43 -0
  182. package/dist/models/metric-create.js +15 -0
  183. package/dist/models/metric-response.d.ts +45 -0
  184. package/dist/models/metric-response.js +15 -0
  185. package/dist/models/metric-type.d.ts +17 -0
  186. package/dist/models/metric-type.js +21 -0
  187. package/dist/models/metric-update.d.ts +24 -0
  188. package/dist/models/metric-update.js +15 -0
  189. package/dist/models/objective-create.d.ts +21 -0
  190. package/dist/models/objective-create.js +15 -0
  191. package/dist/models/objective-response.d.ts +25 -0
  192. package/dist/models/objective-response.js +15 -0
  193. package/dist/models/objective-update.d.ts +18 -0
  194. package/dist/models/objective-update.js +15 -0
  195. package/dist/models/objective-weight-create.d.ts +28 -0
  196. package/dist/models/objective-weight-create.js +15 -0
  197. package/dist/models/objective-weight-response.d.ts +29 -0
  198. package/dist/models/objective-weight-response.js +15 -0
  199. package/dist/models/objective-weight-update.d.ts +17 -0
  200. package/dist/models/objective-weight-update.js +15 -0
  201. package/dist/models/option-create.d.ts +33 -0
  202. package/dist/models/option-create.js +15 -0
  203. package/dist/models/option-response.d.ts +31 -0
  204. package/dist/models/option-response.js +15 -0
  205. package/dist/models/option-update.d.ts +19 -0
  206. package/dist/models/option-update.js +15 -0
  207. package/dist/models/validation-error.d.ts +19 -0
  208. package/dist/models/validation-error.js +15 -0
  209. package/dist/models/value-framework-create.d.ts +21 -0
  210. package/dist/models/value-framework-create.js +15 -0
  211. package/dist/models/value-framework-response.d.ts +25 -0
  212. package/dist/models/value-framework-response.js +15 -0
  213. package/dist/models/value-framework-update.d.ts +18 -0
  214. package/dist/models/value-framework-update.js +15 -0
  215. package/docs/DefaultApi.md +51 -0
  216. package/docs/EvolutionType.md +10 -0
  217. package/docs/HTTPValidationError.md +20 -0
  218. package/docs/ImpactAPIResponse.md +39 -0
  219. package/docs/ImpactApi.md +312 -0
  220. package/docs/ImpactCreate.md +29 -0
  221. package/docs/ImpactUpdate.md +29 -0
  222. package/docs/InvestmentApi.md +875 -0
  223. package/docs/InvestmentCreate.md +23 -0
  224. package/docs/InvestmentResponse.md +31 -0
  225. package/docs/InvestmentUpdate.md +23 -0
  226. package/docs/LocationInner.md +18 -0
  227. package/docs/MeasurementType.md +10 -0
  228. package/docs/MetricApi.md +299 -0
  229. package/docs/MetricCostsApi.md +66 -0
  230. package/docs/MetricCostsPerYearApi.md +307 -0
  231. package/docs/MetricCostsPerYearCreate.md +27 -0
  232. package/docs/MetricCostsPerYearResponse.md +31 -0
  233. package/docs/MetricCostsPerYearUpdate.md +23 -0
  234. package/docs/MetricCreate.md +33 -0
  235. package/docs/MetricResponse.md +43 -0
  236. package/docs/MetricType.md +12 -0
  237. package/docs/MetricUpdate.md +31 -0
  238. package/docs/ObjectiveApi.md +633 -0
  239. package/docs/ObjectiveCreate.md +23 -0
  240. package/docs/ObjectiveResponse.md +31 -0
  241. package/docs/ObjectiveUpdate.md +23 -0
  242. package/docs/ObjectiveWeightApi.md +298 -0
  243. package/docs/ObjectiveWeightCreate.md +25 -0
  244. package/docs/ObjectiveWeightResponse.md +27 -0
  245. package/docs/ObjectiveWeightUpdate.md +21 -0
  246. package/docs/ObjectiveWeightsApi.md +66 -0
  247. package/docs/OptionApi.md +602 -0
  248. package/docs/OptionCreate.md +29 -0
  249. package/docs/OptionResponse.md +37 -0
  250. package/docs/OptionUpdate.md +25 -0
  251. package/docs/ValidationError.md +28 -0
  252. package/docs/ValueFrameworkApi.md +1053 -0
  253. package/docs/ValueFrameworkCostsApi.md +128 -0
  254. package/docs/ValueFrameworkCreate.md +23 -0
  255. package/docs/ValueFrameworkResponse.md +31 -0
  256. package/docs/ValueFrameworkUpdate.md +23 -0
  257. package/docs/ValueFrameworkWeightsApi.md +66 -0
  258. package/index.ts +1 -1
  259. package/models/evolution-type.ts +26 -0
  260. package/models/httpvalidation-error.ts +2 -12
  261. package/models/impact-apiresponse.ts +43 -0
  262. package/models/impact-create.ts +47 -0
  263. package/models/impact-update.ts +32 -0
  264. package/models/index.ts +11 -1
  265. package/models/investment-create.ts +27 -0
  266. package/models/investment-response.ts +31 -0
  267. package/models/investment-update.ts +24 -0
  268. package/models/{validation-error-loc-inner.ts → location-inner.ts} +2 -7
  269. package/models/measurement-type.ts +1 -6
  270. package/models/metric-costs-per-year-create.ts +1 -17
  271. package/models/metric-costs-per-year-response.ts +1 -18
  272. package/models/metric-costs-per-year-update.ts +1 -13
  273. package/models/metric-create.ts +3 -28
  274. package/models/metric-response.ts +3 -50
  275. package/models/metric-type.ts +1 -6
  276. package/models/metric-update.ts +3 -35
  277. package/models/objective-create.ts +1 -10
  278. package/models/objective-response.ts +1 -30
  279. package/models/objective-update.ts +1 -13
  280. package/models/objective-weight-create.ts +1 -9
  281. package/models/objective-weight-response.ts +1 -14
  282. package/models/objective-weight-update.ts +1 -8
  283. package/models/option-create.ts +39 -0
  284. package/models/option-response.ts +37 -0
  285. package/models/option-update.ts +25 -0
  286. package/models/validation-error.ts +3 -33
  287. package/models/value-framework-create.ts +1 -10
  288. package/models/value-framework-response.ts +1 -30
  289. package/models/value-framework-update.ts +1 -13
  290. package/package.json +4 -4
@@ -0,0 +1,458 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Asset Investment Planning
6
+ * API for Asset Investment Planning
7
+ *
8
+ * The version of the OpenAPI document: 0.2.0-dev3
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
+ return new (P || (P = Promise))(function (resolve, reject) {
18
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
22
+ });
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.MetricApi = exports.MetricApiFactory = exports.MetricApiFp = exports.MetricApiAxiosParamCreator = void 0;
26
+ const axios_1 = require("axios");
27
+ // Some imports not used depending on template conditions
28
+ // @ts-ignore
29
+ const common_1 = require("../common");
30
+ // @ts-ignore
31
+ const base_1 = require("../base");
32
+ /**
33
+ * MetricApi - axios parameter creator
34
+ */
35
+ const MetricApiAxiosParamCreator = function (configuration) {
36
+ return {
37
+ /**
38
+ * Create a new metric under this objective.
39
+ * @summary Create a metric for this objective
40
+ * @param {string} objectiveId UUID of the objective
41
+ * @param {MetricCreate} metricCreate
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ createMetricForObjective: (objectiveId_1, metricCreate_1, ...args_1) => __awaiter(this, [objectiveId_1, metricCreate_1, ...args_1], void 0, function* (objectiveId, metricCreate, options = {}) {
46
+ // verify required parameter 'objectiveId' is not null or undefined
47
+ (0, common_1.assertParamExists)('createMetricForObjective', 'objectiveId', objectiveId);
48
+ // verify required parameter 'metricCreate' is not null or undefined
49
+ (0, common_1.assertParamExists)('createMetricForObjective', 'metricCreate', metricCreate);
50
+ const localVarPath = `/objective/{objective_id}/metric/`
51
+ .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
52
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
53
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
54
+ let baseOptions;
55
+ if (configuration) {
56
+ baseOptions = configuration.baseOptions;
57
+ }
58
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
59
+ const localVarHeaderParameter = {};
60
+ const localVarQueryParameter = {};
61
+ // authentication OAuth2AuthorizationCodeBearer required
62
+ // oauth required
63
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
64
+ localVarHeaderParameter['Content-Type'] = 'application/json';
65
+ localVarHeaderParameter['Accept'] = 'application/json';
66
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
67
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
68
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
69
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(metricCreate, localVarRequestOptions, configuration);
70
+ return {
71
+ url: (0, common_1.toPathString)(localVarUrlObj),
72
+ options: localVarRequestOptions,
73
+ };
74
+ }),
75
+ /**
76
+ * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
77
+ * @summary Delete a metric for this objective
78
+ * @param {string} metricId UUID of the metric
79
+ * @param {string} objectiveId UUID of the objective
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ */
83
+ deleteMetricForObjective: (metricId_1, objectiveId_1, ...args_1) => __awaiter(this, [metricId_1, objectiveId_1, ...args_1], void 0, function* (metricId, objectiveId, options = {}) {
84
+ // verify required parameter 'metricId' is not null or undefined
85
+ (0, common_1.assertParamExists)('deleteMetricForObjective', 'metricId', metricId);
86
+ // verify required parameter 'objectiveId' is not null or undefined
87
+ (0, common_1.assertParamExists)('deleteMetricForObjective', 'objectiveId', objectiveId);
88
+ const localVarPath = `/objective/{objective_id}/metric/{metric_id}`
89
+ .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
90
+ .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
91
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
92
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
93
+ let baseOptions;
94
+ if (configuration) {
95
+ baseOptions = configuration.baseOptions;
96
+ }
97
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
98
+ const localVarHeaderParameter = {};
99
+ const localVarQueryParameter = {};
100
+ // authentication OAuth2AuthorizationCodeBearer required
101
+ // oauth required
102
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
103
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
104
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
105
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
106
+ return {
107
+ url: (0, common_1.toPathString)(localVarUrlObj),
108
+ options: localVarRequestOptions,
109
+ };
110
+ }),
111
+ /**
112
+ * Retrieve a specific metric for the objective.
113
+ * @summary Get a metric for this objective
114
+ * @param {string} metricId UUID of the metric
115
+ * @param {string} objectiveId UUID of the objective
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ getMetricForObjective: (metricId_1, objectiveId_1, ...args_1) => __awaiter(this, [metricId_1, objectiveId_1, ...args_1], void 0, function* (metricId, objectiveId, options = {}) {
120
+ // verify required parameter 'metricId' is not null or undefined
121
+ (0, common_1.assertParamExists)('getMetricForObjective', 'metricId', metricId);
122
+ // verify required parameter 'objectiveId' is not null or undefined
123
+ (0, common_1.assertParamExists)('getMetricForObjective', 'objectiveId', objectiveId);
124
+ const localVarPath = `/objective/{objective_id}/metric/{metric_id}`
125
+ .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
126
+ .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
127
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
128
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
129
+ let baseOptions;
130
+ if (configuration) {
131
+ baseOptions = configuration.baseOptions;
132
+ }
133
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
134
+ const localVarHeaderParameter = {};
135
+ const localVarQueryParameter = {};
136
+ // authentication OAuth2AuthorizationCodeBearer required
137
+ // oauth required
138
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
139
+ localVarHeaderParameter['Accept'] = 'application/json';
140
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
141
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
142
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
143
+ return {
144
+ url: (0, common_1.toPathString)(localVarUrlObj),
145
+ options: localVarRequestOptions,
146
+ };
147
+ }),
148
+ /**
149
+ * Retrieve a paginated list of all metrics for a specific objective.
150
+ * @summary List metrics for this objective
151
+ * @param {string} objectiveId UUID of the objective
152
+ * @param {number} [offset] Number of records to skip
153
+ * @param {number} [limit] Max number of records to return
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ */
157
+ getMetricsForObjective: (objectiveId_1, offset_1, limit_1, ...args_1) => __awaiter(this, [objectiveId_1, offset_1, limit_1, ...args_1], void 0, function* (objectiveId, offset, limit, options = {}) {
158
+ // verify required parameter 'objectiveId' is not null or undefined
159
+ (0, common_1.assertParamExists)('getMetricsForObjective', 'objectiveId', objectiveId);
160
+ const localVarPath = `/objective/{objective_id}/metric/`
161
+ .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
162
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
163
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
164
+ let baseOptions;
165
+ if (configuration) {
166
+ baseOptions = configuration.baseOptions;
167
+ }
168
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
169
+ const localVarHeaderParameter = {};
170
+ const localVarQueryParameter = {};
171
+ // authentication OAuth2AuthorizationCodeBearer required
172
+ // oauth required
173
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
174
+ if (offset !== undefined) {
175
+ localVarQueryParameter['offset'] = offset;
176
+ }
177
+ if (limit !== undefined) {
178
+ localVarQueryParameter['limit'] = limit;
179
+ }
180
+ localVarHeaderParameter['Accept'] = 'application/json';
181
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
182
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
183
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
184
+ return {
185
+ url: (0, common_1.toPathString)(localVarUrlObj),
186
+ options: localVarRequestOptions,
187
+ };
188
+ }),
189
+ /**
190
+ * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
191
+ * @summary Partially update a metric for this objective
192
+ * @param {string} metricId UUID of the metric
193
+ * @param {string} objectiveId UUID of the objective
194
+ * @param {MetricUpdate} metricUpdate
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ patchMetricForObjective: (metricId_1, objectiveId_1, metricUpdate_1, ...args_1) => __awaiter(this, [metricId_1, objectiveId_1, metricUpdate_1, ...args_1], void 0, function* (metricId, objectiveId, metricUpdate, options = {}) {
199
+ // verify required parameter 'metricId' is not null or undefined
200
+ (0, common_1.assertParamExists)('patchMetricForObjective', 'metricId', metricId);
201
+ // verify required parameter 'objectiveId' is not null or undefined
202
+ (0, common_1.assertParamExists)('patchMetricForObjective', 'objectiveId', objectiveId);
203
+ // verify required parameter 'metricUpdate' is not null or undefined
204
+ (0, common_1.assertParamExists)('patchMetricForObjective', 'metricUpdate', metricUpdate);
205
+ const localVarPath = `/objective/{objective_id}/metric/{metric_id}`
206
+ .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
207
+ .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)));
208
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
209
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
210
+ let baseOptions;
211
+ if (configuration) {
212
+ baseOptions = configuration.baseOptions;
213
+ }
214
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
215
+ const localVarHeaderParameter = {};
216
+ const localVarQueryParameter = {};
217
+ // authentication OAuth2AuthorizationCodeBearer required
218
+ // oauth required
219
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
220
+ localVarHeaderParameter['Content-Type'] = 'application/json';
221
+ localVarHeaderParameter['Accept'] = 'application/json';
222
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
223
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
224
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
225
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(metricUpdate, localVarRequestOptions, configuration);
226
+ return {
227
+ url: (0, common_1.toPathString)(localVarUrlObj),
228
+ options: localVarRequestOptions,
229
+ };
230
+ }),
231
+ };
232
+ };
233
+ exports.MetricApiAxiosParamCreator = MetricApiAxiosParamCreator;
234
+ /**
235
+ * MetricApi - functional programming interface
236
+ */
237
+ const MetricApiFp = function (configuration) {
238
+ const localVarAxiosParamCreator = (0, exports.MetricApiAxiosParamCreator)(configuration);
239
+ return {
240
+ /**
241
+ * Create a new metric under this objective.
242
+ * @summary Create a metric for this objective
243
+ * @param {string} objectiveId UUID of the objective
244
+ * @param {MetricCreate} metricCreate
245
+ * @param {*} [options] Override http request option.
246
+ * @throws {RequiredError}
247
+ */
248
+ createMetricForObjective(objectiveId, metricCreate, options) {
249
+ return __awaiter(this, void 0, void 0, function* () {
250
+ var _a, _b, _c;
251
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createMetricForObjective(objectiveId, metricCreate, options);
252
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
253
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.createMetricForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
254
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
255
+ });
256
+ },
257
+ /**
258
+ * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
259
+ * @summary Delete a metric for this objective
260
+ * @param {string} metricId UUID of the metric
261
+ * @param {string} objectiveId UUID of the objective
262
+ * @param {*} [options] Override http request option.
263
+ * @throws {RequiredError}
264
+ */
265
+ deleteMetricForObjective(metricId, objectiveId, options) {
266
+ return __awaiter(this, void 0, void 0, function* () {
267
+ var _a, _b, _c;
268
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteMetricForObjective(metricId, objectiveId, options);
269
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
270
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.deleteMetricForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
271
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
272
+ });
273
+ },
274
+ /**
275
+ * Retrieve a specific metric for the objective.
276
+ * @summary Get a metric for this objective
277
+ * @param {string} metricId UUID of the metric
278
+ * @param {string} objectiveId UUID of the objective
279
+ * @param {*} [options] Override http request option.
280
+ * @throws {RequiredError}
281
+ */
282
+ getMetricForObjective(metricId, objectiveId, options) {
283
+ return __awaiter(this, void 0, void 0, function* () {
284
+ var _a, _b, _c;
285
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricForObjective(metricId, objectiveId, options);
286
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
287
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.getMetricForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
288
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
289
+ });
290
+ },
291
+ /**
292
+ * Retrieve a paginated list of all metrics for a specific objective.
293
+ * @summary List metrics for this objective
294
+ * @param {string} objectiveId UUID of the objective
295
+ * @param {number} [offset] Number of records to skip
296
+ * @param {number} [limit] Max number of records to return
297
+ * @param {*} [options] Override http request option.
298
+ * @throws {RequiredError}
299
+ */
300
+ getMetricsForObjective(objectiveId, offset, limit, options) {
301
+ return __awaiter(this, void 0, void 0, function* () {
302
+ var _a, _b, _c;
303
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricsForObjective(objectiveId, offset, limit, options);
304
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
305
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.getMetricsForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
306
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
307
+ });
308
+ },
309
+ /**
310
+ * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
311
+ * @summary Partially update a metric for this objective
312
+ * @param {string} metricId UUID of the metric
313
+ * @param {string} objectiveId UUID of the objective
314
+ * @param {MetricUpdate} metricUpdate
315
+ * @param {*} [options] Override http request option.
316
+ * @throws {RequiredError}
317
+ */
318
+ patchMetricForObjective(metricId, objectiveId, metricUpdate, options) {
319
+ return __awaiter(this, void 0, void 0, function* () {
320
+ var _a, _b, _c;
321
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.patchMetricForObjective(metricId, objectiveId, metricUpdate, options);
322
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
323
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetricApi.patchMetricForObjective']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
324
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
325
+ });
326
+ },
327
+ };
328
+ };
329
+ exports.MetricApiFp = MetricApiFp;
330
+ /**
331
+ * MetricApi - factory interface
332
+ */
333
+ const MetricApiFactory = function (configuration, basePath, axios) {
334
+ const localVarFp = (0, exports.MetricApiFp)(configuration);
335
+ return {
336
+ /**
337
+ * Create a new metric under this objective.
338
+ * @summary Create a metric for this objective
339
+ * @param {string} objectiveId UUID of the objective
340
+ * @param {MetricCreate} metricCreate
341
+ * @param {*} [options] Override http request option.
342
+ * @throws {RequiredError}
343
+ */
344
+ createMetricForObjective(objectiveId, metricCreate, options) {
345
+ return localVarFp.createMetricForObjective(objectiveId, metricCreate, options).then((request) => request(axios, basePath));
346
+ },
347
+ /**
348
+ * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
349
+ * @summary Delete a metric for this objective
350
+ * @param {string} metricId UUID of the metric
351
+ * @param {string} objectiveId UUID of the objective
352
+ * @param {*} [options] Override http request option.
353
+ * @throws {RequiredError}
354
+ */
355
+ deleteMetricForObjective(metricId, objectiveId, options) {
356
+ return localVarFp.deleteMetricForObjective(metricId, objectiveId, options).then((request) => request(axios, basePath));
357
+ },
358
+ /**
359
+ * Retrieve a specific metric for the objective.
360
+ * @summary Get a metric for this objective
361
+ * @param {string} metricId UUID of the metric
362
+ * @param {string} objectiveId UUID of the objective
363
+ * @param {*} [options] Override http request option.
364
+ * @throws {RequiredError}
365
+ */
366
+ getMetricForObjective(metricId, objectiveId, options) {
367
+ return localVarFp.getMetricForObjective(metricId, objectiveId, options).then((request) => request(axios, basePath));
368
+ },
369
+ /**
370
+ * Retrieve a paginated list of all metrics for a specific objective.
371
+ * @summary List metrics for this objective
372
+ * @param {string} objectiveId UUID of the objective
373
+ * @param {number} [offset] Number of records to skip
374
+ * @param {number} [limit] Max number of records to return
375
+ * @param {*} [options] Override http request option.
376
+ * @throws {RequiredError}
377
+ */
378
+ getMetricsForObjective(objectiveId, offset, limit, options) {
379
+ return localVarFp.getMetricsForObjective(objectiveId, offset, limit, options).then((request) => request(axios, basePath));
380
+ },
381
+ /**
382
+ * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
383
+ * @summary Partially update a metric for this objective
384
+ * @param {string} metricId UUID of the metric
385
+ * @param {string} objectiveId UUID of the objective
386
+ * @param {MetricUpdate} metricUpdate
387
+ * @param {*} [options] Override http request option.
388
+ * @throws {RequiredError}
389
+ */
390
+ patchMetricForObjective(metricId, objectiveId, metricUpdate, options) {
391
+ return localVarFp.patchMetricForObjective(metricId, objectiveId, metricUpdate, options).then((request) => request(axios, basePath));
392
+ },
393
+ };
394
+ };
395
+ exports.MetricApiFactory = MetricApiFactory;
396
+ /**
397
+ * MetricApi - object-oriented interface
398
+ */
399
+ class MetricApi extends base_1.BaseAPI {
400
+ /**
401
+ * Create a new metric under this objective.
402
+ * @summary Create a metric for this objective
403
+ * @param {string} objectiveId UUID of the objective
404
+ * @param {MetricCreate} metricCreate
405
+ * @param {*} [options] Override http request option.
406
+ * @throws {RequiredError}
407
+ */
408
+ createMetricForObjective(objectiveId, metricCreate, options) {
409
+ return (0, exports.MetricApiFp)(this.configuration).createMetricForObjective(objectiveId, metricCreate, options).then((request) => request(this.axios, this.basePath));
410
+ }
411
+ /**
412
+ * Delete an existing metric by its ID. Associated metric costs per year are also deleted via cascade.
413
+ * @summary Delete a metric for this objective
414
+ * @param {string} metricId UUID of the metric
415
+ * @param {string} objectiveId UUID of the objective
416
+ * @param {*} [options] Override http request option.
417
+ * @throws {RequiredError}
418
+ */
419
+ deleteMetricForObjective(metricId, objectiveId, options) {
420
+ return (0, exports.MetricApiFp)(this.configuration).deleteMetricForObjective(metricId, objectiveId, options).then((request) => request(this.axios, this.basePath));
421
+ }
422
+ /**
423
+ * Retrieve a specific metric for the objective.
424
+ * @summary Get a metric for this objective
425
+ * @param {string} metricId UUID of the metric
426
+ * @param {string} objectiveId UUID of the objective
427
+ * @param {*} [options] Override http request option.
428
+ * @throws {RequiredError}
429
+ */
430
+ getMetricForObjective(metricId, objectiveId, options) {
431
+ return (0, exports.MetricApiFp)(this.configuration).getMetricForObjective(metricId, objectiveId, options).then((request) => request(this.axios, this.basePath));
432
+ }
433
+ /**
434
+ * Retrieve a paginated list of all metrics for a specific objective.
435
+ * @summary List metrics for this objective
436
+ * @param {string} objectiveId UUID of the objective
437
+ * @param {number} [offset] Number of records to skip
438
+ * @param {number} [limit] Max number of records to return
439
+ * @param {*} [options] Override http request option.
440
+ * @throws {RequiredError}
441
+ */
442
+ getMetricsForObjective(objectiveId, offset, limit, options) {
443
+ return (0, exports.MetricApiFp)(this.configuration).getMetricsForObjective(objectiveId, offset, limit, options).then((request) => request(this.axios, this.basePath));
444
+ }
445
+ /**
446
+ * Update one or more fields of an existing metric. Only the fields included in the request body will be modified; omitted fields remain unchanged.
447
+ * @summary Partially update a metric for this objective
448
+ * @param {string} metricId UUID of the metric
449
+ * @param {string} objectiveId UUID of the objective
450
+ * @param {MetricUpdate} metricUpdate
451
+ * @param {*} [options] Override http request option.
452
+ * @throws {RequiredError}
453
+ */
454
+ patchMetricForObjective(metricId, objectiveId, metricUpdate, options) {
455
+ return (0, exports.MetricApiFp)(this.configuration).patchMetricForObjective(metricId, objectiveId, metricUpdate, options).then((request) => request(this.axios, this.basePath));
456
+ }
457
+ }
458
+ exports.MetricApi = MetricApi;
@@ -0,0 +1,75 @@
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 { MetricCostsPerYearResponse } from '../models';
16
+ /**
17
+ * MetricCostsApi - axios parameter creator
18
+ */
19
+ export declare const MetricCostsApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ /**
21
+ * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
22
+ * @summary List all metric costs for a metric
23
+ * @param {string} metricId UUID of the metric
24
+ * @param {number} [offset] Number of records to skip
25
+ * @param {number} [limit] Max number of records to return
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ getCostsForMetric: (metricId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
30
+ };
31
+ /**
32
+ * MetricCostsApi - functional programming interface
33
+ */
34
+ export declare const MetricCostsApiFp: (configuration?: Configuration) => {
35
+ /**
36
+ * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
37
+ * @summary List all metric costs for a metric
38
+ * @param {string} metricId UUID of the metric
39
+ * @param {number} [offset] Number of records to skip
40
+ * @param {number} [limit] Max number of records to return
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ getCostsForMetric(metricId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>>;
45
+ };
46
+ /**
47
+ * MetricCostsApi - factory interface
48
+ */
49
+ export declare const MetricCostsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
50
+ /**
51
+ * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
52
+ * @summary List all metric costs for a metric
53
+ * @param {string} metricId UUID of the metric
54
+ * @param {number} [offset] Number of records to skip
55
+ * @param {number} [limit] Max number of records to return
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ */
59
+ getCostsForMetric(metricId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>>;
60
+ };
61
+ /**
62
+ * MetricCostsApi - object-oriented interface
63
+ */
64
+ export declare class MetricCostsApi extends BaseAPI {
65
+ /**
66
+ * Retrieve a paginated list of all metric costs for a specific metric across all frameworks.
67
+ * @summary List all metric costs for a metric
68
+ * @param {string} metricId UUID of the metric
69
+ * @param {number} [offset] Number of records to skip
70
+ * @param {number} [limit] Max number of records to return
71
+ * @param {*} [options] Override http request option.
72
+ * @throws {RequiredError}
73
+ */
74
+ getCostsForMetric(metricId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetricCostsPerYearResponse[], any, {}>>;
75
+ }