@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.
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 +3 -10
  20. package/dist/api/default-api.js +7 -13
  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 +97 -88
  26. package/dist/api/metric-api.js +185 -157
  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 +105 -108
  30. package/dist/api/metric-costs-per-year-api.js +199 -192
  31. package/dist/api/objective-api.d.ts +242 -21
  32. package/dist/api/objective-api.js +508 -37
  33. package/dist/api/objective-weight-api.d.ts +105 -108
  34. package/dist/api/objective-weight-api.js +189 -182
  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 +528 -21
  40. package/dist/api/value-framework-api.js +1138 -78
  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 +8 -1
  46. package/dist/api.js +8 -1
  47. package/dist/base.d.ts +1 -25
  48. package/dist/base.js +1 -20
  49. package/dist/common.d.ts +6 -37
  50. package/dist/common.js +17 -39
  51. package/dist/configuration.d.ts +25 -18
  52. package/dist/configuration.js +4 -3
  53. package/dist/esm/api/default-api.d.ts +3 -10
  54. package/dist/esm/api/default-api.js +7 -13
  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 +97 -88
  60. package/dist/esm/api/metric-api.js +185 -157
  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 +105 -108
  64. package/dist/esm/api/metric-costs-per-year-api.js +199 -192
  65. package/dist/esm/api/objective-api.d.ts +242 -21
  66. package/dist/esm/api/objective-api.js +508 -37
  67. package/dist/esm/api/objective-weight-api.d.ts +105 -108
  68. package/dist/esm/api/objective-weight-api.js +189 -182
  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 +528 -21
  74. package/dist/esm/api/value-framework-api.js +1137 -77
  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 +8 -1
  80. package/dist/esm/api.js +8 -1
  81. package/dist/esm/base.d.ts +1 -25
  82. package/dist/esm/base.js +1 -20
  83. package/dist/esm/common.d.ts +6 -37
  84. package/dist/esm/common.js +15 -38
  85. package/dist/esm/configuration.d.ts +25 -18
  86. package/dist/esm/configuration.js +4 -3
  87. package/dist/esm/index.d.ts +1 -1
  88. package/dist/esm/index.js +1 -1
  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 +2 -12
  92. package/dist/esm/models/httpvalidation-error.js +1 -1
  93. package/dist/esm/models/impact-apiresponse.d.ts +33 -0
  94. package/dist/esm/models/{validation-error-loc-inner.js → impact-apiresponse.js} +1 -1
  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 +11 -1
  100. package/dist/esm/models/index.js +11 -1
  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/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
  108. package/dist/esm/models/location-inner.js +14 -0
  109. package/dist/esm/models/measurement-type.d.ts +1 -6
  110. package/dist/esm/models/measurement-type.js +1 -6
  111. package/dist/esm/models/metric-costs-per-year-create.d.ts +1 -17
  112. package/dist/esm/models/metric-costs-per-year-create.js +1 -1
  113. package/dist/esm/models/metric-costs-per-year-response.d.ts +1 -18
  114. package/dist/esm/models/metric-costs-per-year-response.js +1 -1
  115. package/dist/esm/models/metric-costs-per-year-update.d.ts +1 -13
  116. package/dist/esm/models/metric-costs-per-year-update.js +1 -1
  117. package/dist/esm/models/metric-create.d.ts +3 -28
  118. package/dist/esm/models/metric-create.js +1 -1
  119. package/dist/esm/models/metric-response.d.ts +3 -50
  120. package/dist/esm/models/metric-response.js +1 -1
  121. package/dist/esm/models/metric-type.d.ts +1 -6
  122. package/dist/esm/models/metric-type.js +1 -6
  123. package/dist/esm/models/metric-update.d.ts +3 -35
  124. package/dist/esm/models/metric-update.js +1 -1
  125. package/dist/esm/models/objective-create.d.ts +1 -10
  126. package/dist/esm/models/objective-create.js +1 -1
  127. package/dist/esm/models/objective-response.d.ts +1 -30
  128. package/dist/esm/models/objective-response.js +1 -1
  129. package/dist/esm/models/objective-update.d.ts +1 -13
  130. package/dist/esm/models/objective-update.js +1 -1
  131. package/dist/esm/models/objective-weight-create.d.ts +1 -9
  132. package/dist/esm/models/objective-weight-create.js +1 -1
  133. package/dist/esm/models/objective-weight-response.d.ts +1 -14
  134. package/dist/esm/models/objective-weight-response.js +1 -1
  135. package/dist/esm/models/objective-weight-update.d.ts +1 -8
  136. package/dist/esm/models/objective-weight-update.js +1 -1
  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 +3 -33
  144. package/dist/esm/models/validation-error.js +1 -1
  145. package/dist/esm/models/value-framework-create.d.ts +1 -10
  146. package/dist/esm/models/value-framework-create.js +1 -1
  147. package/dist/esm/models/value-framework-response.d.ts +1 -30
  148. package/dist/esm/models/value-framework-response.js +1 -1
  149. package/dist/esm/models/value-framework-update.d.ts +1 -13
  150. package/dist/esm/models/value-framework-update.js +1 -1
  151. package/dist/index.d.ts +1 -1
  152. package/dist/index.js +1 -1
  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 +2 -12
  156. package/dist/models/httpvalidation-error.js +1 -1
  157. package/dist/models/impact-apiresponse.d.ts +33 -0
  158. package/dist/models/{validation-error-loc-inner.js → impact-apiresponse.js} +1 -1
  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 +11 -1
  164. package/dist/models/index.js +11 -1
  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/{validation-error-loc-inner.d.ts → location-inner.d.ts} +2 -7
  172. package/dist/models/location-inner.js +15 -0
  173. package/dist/models/measurement-type.d.ts +1 -6
  174. package/dist/models/measurement-type.js +1 -6
  175. package/dist/models/metric-costs-per-year-create.d.ts +1 -17
  176. package/dist/models/metric-costs-per-year-create.js +1 -1
  177. package/dist/models/metric-costs-per-year-response.d.ts +1 -18
  178. package/dist/models/metric-costs-per-year-response.js +1 -1
  179. package/dist/models/metric-costs-per-year-update.d.ts +1 -13
  180. package/dist/models/metric-costs-per-year-update.js +1 -1
  181. package/dist/models/metric-create.d.ts +3 -28
  182. package/dist/models/metric-create.js +1 -1
  183. package/dist/models/metric-response.d.ts +3 -50
  184. package/dist/models/metric-response.js +1 -1
  185. package/dist/models/metric-type.d.ts +1 -6
  186. package/dist/models/metric-type.js +1 -6
  187. package/dist/models/metric-update.d.ts +3 -35
  188. package/dist/models/metric-update.js +1 -1
  189. package/dist/models/objective-create.d.ts +1 -10
  190. package/dist/models/objective-create.js +1 -1
  191. package/dist/models/objective-response.d.ts +1 -30
  192. package/dist/models/objective-response.js +1 -1
  193. package/dist/models/objective-update.d.ts +1 -13
  194. package/dist/models/objective-update.js +1 -1
  195. package/dist/models/objective-weight-create.d.ts +1 -9
  196. package/dist/models/objective-weight-create.js +1 -1
  197. package/dist/models/objective-weight-response.d.ts +1 -14
  198. package/dist/models/objective-weight-response.js +1 -1
  199. package/dist/models/objective-weight-update.d.ts +1 -8
  200. package/dist/models/objective-weight-update.js +1 -1
  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 +3 -33
  208. package/dist/models/validation-error.js +1 -1
  209. package/dist/models/value-framework-create.d.ts +1 -10
  210. package/dist/models/value-framework-create.js +1 -1
  211. package/dist/models/value-framework-response.d.ts +1 -30
  212. package/dist/models/value-framework-response.js +1 -1
  213. package/dist/models/value-framework-update.d.ts +1 -13
  214. package/dist/models/value-framework-update.js +1 -1
  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
@@ -4,7 +4,7 @@
4
4
  * Asset Investment Planning
5
5
  * API for Asset Investment Planning
6
6
  *
7
- * The version of the OpenAPI document: 0.2.0-dev2
7
+ * The version of the OpenAPI document: 0.2.0-dev3
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,10 +28,161 @@ import { DUMMY_BASE_URL, assertParamExists, setOAuthToObject, setSearchParams, s
28
28
  import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
29
29
  /**
30
30
  * ValueFrameworkApi - axios parameter creator
31
- * @export
32
31
  */
33
32
  export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
34
33
  return {
34
+ /**
35
+ * Create a yearly cost override for a metric within this framework.
36
+ * @summary Create a yearly metric cost for this framework
37
+ * @param {string} valueFrameworkId UUID of the value framework
38
+ * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ createMetricCostForFramework: (valueFrameworkId_1, metricCostsPerYearCreate_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, metricCostsPerYearCreate_1, ...args_1], void 0, function* (valueFrameworkId, metricCostsPerYearCreate, options = {}) {
43
+ // verify required parameter 'valueFrameworkId' is not null or undefined
44
+ assertParamExists('createMetricCostForFramework', 'valueFrameworkId', valueFrameworkId);
45
+ // verify required parameter 'metricCostsPerYearCreate' is not null or undefined
46
+ assertParamExists('createMetricCostForFramework', 'metricCostsPerYearCreate', metricCostsPerYearCreate);
47
+ const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/`
48
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
49
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
50
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
51
+ let baseOptions;
52
+ if (configuration) {
53
+ baseOptions = configuration.baseOptions;
54
+ }
55
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
56
+ const localVarHeaderParameter = {};
57
+ const localVarQueryParameter = {};
58
+ // authentication OAuth2AuthorizationCodeBearer required
59
+ // oauth required
60
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
61
+ localVarHeaderParameter['Content-Type'] = 'application/json';
62
+ localVarHeaderParameter['Accept'] = 'application/json';
63
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
64
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
65
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
66
+ localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearCreate, localVarRequestOptions, configuration);
67
+ return {
68
+ url: toPathString(localVarUrlObj),
69
+ options: localVarRequestOptions,
70
+ };
71
+ }),
72
+ /**
73
+ * Assign a weight to an objective within this framework.
74
+ * @summary Create an objective weight for this framework
75
+ * @param {string} valueFrameworkId UUID of the value framework
76
+ * @param {ObjectiveWeightCreate} objectiveWeightCreate
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ createObjectiveWeightForFramework: (valueFrameworkId_1, objectiveWeightCreate_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, objectiveWeightCreate_1, ...args_1], void 0, function* (valueFrameworkId, objectiveWeightCreate, options = {}) {
81
+ // verify required parameter 'valueFrameworkId' is not null or undefined
82
+ assertParamExists('createObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId);
83
+ // verify required parameter 'objectiveWeightCreate' is not null or undefined
84
+ assertParamExists('createObjectiveWeightForFramework', 'objectiveWeightCreate', objectiveWeightCreate);
85
+ const localVarPath = `/value_framework/{value_framework_id}/objective_weight/`
86
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
87
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
88
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
89
+ let baseOptions;
90
+ if (configuration) {
91
+ baseOptions = configuration.baseOptions;
92
+ }
93
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
94
+ const localVarHeaderParameter = {};
95
+ const localVarQueryParameter = {};
96
+ // authentication OAuth2AuthorizationCodeBearer required
97
+ // oauth required
98
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
99
+ localVarHeaderParameter['Content-Type'] = 'application/json';
100
+ localVarHeaderParameter['Accept'] = 'application/json';
101
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
102
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
103
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
104
+ localVarRequestOptions.data = serializeDataIfNeeded(objectiveWeightCreate, localVarRequestOptions, configuration);
105
+ return {
106
+ url: toPathString(localVarUrlObj),
107
+ options: localVarRequestOptions,
108
+ };
109
+ }),
110
+ /**
111
+ * Delete a metric cost entry for a specific year within this framework.
112
+ * @summary Delete metric costs for this framework
113
+ * @param {string} metricId UUID of the metric
114
+ * @param {number} year Year (1600-3000)
115
+ * @param {string} valueFrameworkId UUID of the value framework
116
+ * @param {*} [options] Override http request option.
117
+ * @throws {RequiredError}
118
+ */
119
+ deleteMetricCostForFramework: (metricId_1, year_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [metricId_1, year_1, valueFrameworkId_1, ...args_1], void 0, function* (metricId, year, valueFrameworkId, options = {}) {
120
+ // verify required parameter 'metricId' is not null or undefined
121
+ assertParamExists('deleteMetricCostForFramework', 'metricId', metricId);
122
+ // verify required parameter 'year' is not null or undefined
123
+ assertParamExists('deleteMetricCostForFramework', 'year', year);
124
+ // verify required parameter 'valueFrameworkId' is not null or undefined
125
+ assertParamExists('deleteMetricCostForFramework', 'valueFrameworkId', valueFrameworkId);
126
+ const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
127
+ .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
128
+ .replace(`{${"year"}}`, encodeURIComponent(String(year)))
129
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
130
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
131
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
132
+ let baseOptions;
133
+ if (configuration) {
134
+ baseOptions = configuration.baseOptions;
135
+ }
136
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
137
+ const localVarHeaderParameter = {};
138
+ const localVarQueryParameter = {};
139
+ // authentication OAuth2AuthorizationCodeBearer required
140
+ // oauth required
141
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
142
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
143
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
144
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
145
+ return {
146
+ url: toPathString(localVarUrlObj),
147
+ options: localVarRequestOptions,
148
+ };
149
+ }),
150
+ /**
151
+ * Remove an objective weight from this framework.
152
+ * @summary Delete an objective weight for this framework
153
+ * @param {string} objectiveId UUID of the objective
154
+ * @param {string} valueFrameworkId UUID of the value framework
155
+ * @param {*} [options] Override http request option.
156
+ * @throws {RequiredError}
157
+ */
158
+ deleteObjectiveWeightForFramework: (objectiveId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [objectiveId_1, valueFrameworkId_1, ...args_1], void 0, function* (objectiveId, valueFrameworkId, options = {}) {
159
+ // verify required parameter 'objectiveId' is not null or undefined
160
+ assertParamExists('deleteObjectiveWeightForFramework', 'objectiveId', objectiveId);
161
+ // verify required parameter 'valueFrameworkId' is not null or undefined
162
+ assertParamExists('deleteObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId);
163
+ const localVarPath = `/value_framework/{value_framework_id}/objective_weight/{objective_id}`
164
+ .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)))
165
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
166
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
167
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
168
+ let baseOptions;
169
+ if (configuration) {
170
+ baseOptions = configuration.baseOptions;
171
+ }
172
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
173
+ const localVarHeaderParameter = {};
174
+ const localVarQueryParameter = {};
175
+ // authentication OAuth2AuthorizationCodeBearer required
176
+ // oauth required
177
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
178
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
179
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
180
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
181
+ return {
182
+ url: toPathString(localVarUrlObj),
183
+ options: localVarRequestOptions,
184
+ };
185
+ }),
35
186
  /**
36
187
  * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
37
188
  * @summary Delete a value framework
@@ -39,7 +190,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
39
190
  * @param {*} [options] Override http request option.
40
191
  * @throws {RequiredError}
41
192
  */
42
- deleteValueFramework: (valueFrameworkId, options = {}) => __awaiter(this, void 0, void 0, function* () {
193
+ deleteValueFramework: (valueFrameworkId_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, ...args_1], void 0, function* (valueFrameworkId, options = {}) {
43
194
  // verify required parameter 'valueFrameworkId' is not null or undefined
44
195
  assertParamExists('deleteValueFramework', 'valueFrameworkId', valueFrameworkId);
45
196
  const localVarPath = `/value_framework/{value_framework_id}`
@@ -64,6 +215,252 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
64
215
  options: localVarRequestOptions,
65
216
  };
66
217
  }),
218
+ /**
219
+ * Retrieve a paginated list of all metric costs for a specific value framework.
220
+ * @summary List all metric costs for a value framework
221
+ * @param {string} valueFrameworkId UUID of the value framework
222
+ * @param {number} [offset] Number of records to skip
223
+ * @param {number} [limit] Max number of records to return
224
+ * @param {*} [options] Override http request option.
225
+ * @throws {RequiredError}
226
+ */
227
+ getCostsForValueFramework: (valueFrameworkId_1, offset_1, limit_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, offset_1, limit_1, ...args_1], void 0, function* (valueFrameworkId, offset, limit, options = {}) {
228
+ // verify required parameter 'valueFrameworkId' is not null or undefined
229
+ assertParamExists('getCostsForValueFramework', 'valueFrameworkId', valueFrameworkId);
230
+ const localVarPath = `/value_framework/{value_framework_id}/costs/`
231
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
232
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
233
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
234
+ let baseOptions;
235
+ if (configuration) {
236
+ baseOptions = configuration.baseOptions;
237
+ }
238
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
239
+ const localVarHeaderParameter = {};
240
+ const localVarQueryParameter = {};
241
+ // authentication OAuth2AuthorizationCodeBearer required
242
+ // oauth required
243
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
244
+ if (offset !== undefined) {
245
+ localVarQueryParameter['offset'] = offset;
246
+ }
247
+ if (limit !== undefined) {
248
+ localVarQueryParameter['limit'] = limit;
249
+ }
250
+ localVarHeaderParameter['Accept'] = 'application/json';
251
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
252
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
253
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
254
+ return {
255
+ url: toPathString(localVarUrlObj),
256
+ options: localVarRequestOptions,
257
+ };
258
+ }),
259
+ /**
260
+ * Retrieve a paginated list of metric costs for a specific metric within a value framework.
261
+ * @summary List metric costs for a value framework filtered by metric
262
+ * @param {string} metricId UUID of the metric
263
+ * @param {string} valueFrameworkId UUID of the value framework
264
+ * @param {number} [offset] Number of records to skip
265
+ * @param {number} [limit] Max number of records to return
266
+ * @param {*} [options] Override http request option.
267
+ * @throws {RequiredError}
268
+ */
269
+ getCostsForValueFrameworkByMetric: (metricId_1, valueFrameworkId_1, offset_1, limit_1, ...args_1) => __awaiter(this, [metricId_1, valueFrameworkId_1, offset_1, limit_1, ...args_1], void 0, function* (metricId, valueFrameworkId, offset, limit, options = {}) {
270
+ // verify required parameter 'metricId' is not null or undefined
271
+ assertParamExists('getCostsForValueFrameworkByMetric', 'metricId', metricId);
272
+ // verify required parameter 'valueFrameworkId' is not null or undefined
273
+ assertParamExists('getCostsForValueFrameworkByMetric', 'valueFrameworkId', valueFrameworkId);
274
+ const localVarPath = `/value_framework/{value_framework_id}/costs/{metric_id}`
275
+ .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
276
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
277
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
278
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
279
+ let baseOptions;
280
+ if (configuration) {
281
+ baseOptions = configuration.baseOptions;
282
+ }
283
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
284
+ const localVarHeaderParameter = {};
285
+ const localVarQueryParameter = {};
286
+ // authentication OAuth2AuthorizationCodeBearer required
287
+ // oauth required
288
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
289
+ if (offset !== undefined) {
290
+ localVarQueryParameter['offset'] = offset;
291
+ }
292
+ if (limit !== undefined) {
293
+ localVarQueryParameter['limit'] = limit;
294
+ }
295
+ localVarHeaderParameter['Accept'] = 'application/json';
296
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
297
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
298
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
299
+ return {
300
+ url: toPathString(localVarUrlObj),
301
+ options: localVarRequestOptions,
302
+ };
303
+ }),
304
+ /**
305
+ * Retrieve cost data for a specific metric within this framework for a given year.
306
+ * @summary Get a yearly metric cost for this framework
307
+ * @param {string} metricId UUID of the metric
308
+ * @param {number} year Year (1600-3000)
309
+ * @param {string} valueFrameworkId UUID of the value framework
310
+ * @param {*} [options] Override http request option.
311
+ * @throws {RequiredError}
312
+ */
313
+ getMetricCostForFramework: (metricId_1, year_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [metricId_1, year_1, valueFrameworkId_1, ...args_1], void 0, function* (metricId, year, valueFrameworkId, options = {}) {
314
+ // verify required parameter 'metricId' is not null or undefined
315
+ assertParamExists('getMetricCostForFramework', 'metricId', metricId);
316
+ // verify required parameter 'year' is not null or undefined
317
+ assertParamExists('getMetricCostForFramework', 'year', year);
318
+ // verify required parameter 'valueFrameworkId' is not null or undefined
319
+ assertParamExists('getMetricCostForFramework', 'valueFrameworkId', valueFrameworkId);
320
+ const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
321
+ .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
322
+ .replace(`{${"year"}}`, encodeURIComponent(String(year)))
323
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
324
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
325
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
326
+ let baseOptions;
327
+ if (configuration) {
328
+ baseOptions = configuration.baseOptions;
329
+ }
330
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
331
+ const localVarHeaderParameter = {};
332
+ const localVarQueryParameter = {};
333
+ // authentication OAuth2AuthorizationCodeBearer required
334
+ // oauth required
335
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
336
+ localVarHeaderParameter['Accept'] = 'application/json';
337
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
338
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
339
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
340
+ return {
341
+ url: toPathString(localVarUrlObj),
342
+ options: localVarRequestOptions,
343
+ };
344
+ }),
345
+ /**
346
+ * Retrieve a paginated list of all yearly metric costs for a specific framework.
347
+ * @summary List yearly metric costs for this framework
348
+ * @param {string} valueFrameworkId UUID of the value framework
349
+ * @param {number} [offset] Number of records to skip
350
+ * @param {number} [limit] Max number of records to return
351
+ * @param {*} [options] Override http request option.
352
+ * @throws {RequiredError}
353
+ */
354
+ getMetricCostsForFramework: (valueFrameworkId_1, offset_1, limit_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, offset_1, limit_1, ...args_1], void 0, function* (valueFrameworkId, offset, limit, options = {}) {
355
+ // verify required parameter 'valueFrameworkId' is not null or undefined
356
+ assertParamExists('getMetricCostsForFramework', 'valueFrameworkId', valueFrameworkId);
357
+ const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/`
358
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
359
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
360
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
361
+ let baseOptions;
362
+ if (configuration) {
363
+ baseOptions = configuration.baseOptions;
364
+ }
365
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
366
+ const localVarHeaderParameter = {};
367
+ const localVarQueryParameter = {};
368
+ // authentication OAuth2AuthorizationCodeBearer required
369
+ // oauth required
370
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
371
+ if (offset !== undefined) {
372
+ localVarQueryParameter['offset'] = offset;
373
+ }
374
+ if (limit !== undefined) {
375
+ localVarQueryParameter['limit'] = limit;
376
+ }
377
+ localVarHeaderParameter['Accept'] = 'application/json';
378
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
379
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
380
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
381
+ return {
382
+ url: toPathString(localVarUrlObj),
383
+ options: localVarRequestOptions,
384
+ };
385
+ }),
386
+ /**
387
+ * Retrieve the weight for a specific objective within this framework.
388
+ * @summary Get an objective weight for this framework
389
+ * @param {string} objectiveId UUID of the objective
390
+ * @param {string} valueFrameworkId UUID of the value framework
391
+ * @param {*} [options] Override http request option.
392
+ * @throws {RequiredError}
393
+ */
394
+ getObjectiveWeightForFramework: (objectiveId_1, valueFrameworkId_1, ...args_1) => __awaiter(this, [objectiveId_1, valueFrameworkId_1, ...args_1], void 0, function* (objectiveId, valueFrameworkId, options = {}) {
395
+ // verify required parameter 'objectiveId' is not null or undefined
396
+ assertParamExists('getObjectiveWeightForFramework', 'objectiveId', objectiveId);
397
+ // verify required parameter 'valueFrameworkId' is not null or undefined
398
+ assertParamExists('getObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId);
399
+ const localVarPath = `/value_framework/{value_framework_id}/objective_weight/{objective_id}`
400
+ .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)))
401
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
402
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
403
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
404
+ let baseOptions;
405
+ if (configuration) {
406
+ baseOptions = configuration.baseOptions;
407
+ }
408
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
409
+ const localVarHeaderParameter = {};
410
+ const localVarQueryParameter = {};
411
+ // authentication OAuth2AuthorizationCodeBearer required
412
+ // oauth required
413
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
414
+ localVarHeaderParameter['Accept'] = 'application/json';
415
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
416
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
417
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
418
+ return {
419
+ url: toPathString(localVarUrlObj),
420
+ options: localVarRequestOptions,
421
+ };
422
+ }),
423
+ /**
424
+ * Retrieve a paginated list of all objective weights for a specific framework.
425
+ * @summary List objective weights for this framework
426
+ * @param {string} valueFrameworkId UUID of the value framework
427
+ * @param {number} [offset] Number of records to skip
428
+ * @param {number} [limit] Max number of records to return
429
+ * @param {*} [options] Override http request option.
430
+ * @throws {RequiredError}
431
+ */
432
+ getObjectiveWeightsForFramework: (valueFrameworkId_1, offset_1, limit_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, offset_1, limit_1, ...args_1], void 0, function* (valueFrameworkId, offset, limit, options = {}) {
433
+ // verify required parameter 'valueFrameworkId' is not null or undefined
434
+ assertParamExists('getObjectiveWeightsForFramework', 'valueFrameworkId', valueFrameworkId);
435
+ const localVarPath = `/value_framework/{value_framework_id}/objective_weight/`
436
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
437
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
438
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
439
+ let baseOptions;
440
+ if (configuration) {
441
+ baseOptions = configuration.baseOptions;
442
+ }
443
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
444
+ const localVarHeaderParameter = {};
445
+ const localVarQueryParameter = {};
446
+ // authentication OAuth2AuthorizationCodeBearer required
447
+ // oauth required
448
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
449
+ if (offset !== undefined) {
450
+ localVarQueryParameter['offset'] = offset;
451
+ }
452
+ if (limit !== undefined) {
453
+ localVarQueryParameter['limit'] = limit;
454
+ }
455
+ localVarHeaderParameter['Accept'] = 'application/json';
456
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
457
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
458
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
459
+ return {
460
+ url: toPathString(localVarUrlObj),
461
+ options: localVarRequestOptions,
462
+ };
463
+ }),
67
464
  /**
68
465
  * Retrieve a single value framework by its ID.
69
466
  * @summary Get a value framework by ID
@@ -71,7 +468,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
71
468
  * @param {*} [options] Override http request option.
72
469
  * @throws {RequiredError}
73
470
  */
74
- getValueFrameworkById: (valueFrameworkId, options = {}) => __awaiter(this, void 0, void 0, function* () {
471
+ getValueFrameworkById: (valueFrameworkId_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, ...args_1], void 0, function* (valueFrameworkId, options = {}) {
75
472
  // verify required parameter 'valueFrameworkId' is not null or undefined
76
473
  assertParamExists('getValueFrameworkById', 'valueFrameworkId', valueFrameworkId);
77
474
  const localVarPath = `/value_framework/{value_framework_id}`
@@ -88,6 +485,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
88
485
  // authentication OAuth2AuthorizationCodeBearer required
89
486
  // oauth required
90
487
  yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
488
+ localVarHeaderParameter['Accept'] = 'application/json';
91
489
  setSearchParams(localVarUrlObj, localVarQueryParameter);
92
490
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
93
491
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -104,7 +502,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
104
502
  * @param {*} [options] Override http request option.
105
503
  * @throws {RequiredError}
106
504
  */
107
- getValueFrameworks: (offset, limit, options = {}) => __awaiter(this, void 0, void 0, function* () {
505
+ getValueFrameworks: (offset_1, limit_1, ...args_1) => __awaiter(this, [offset_1, limit_1, ...args_1], void 0, function* (offset, limit, options = {}) {
108
506
  const localVarPath = `/value_framework/`;
109
507
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
110
508
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -124,9 +522,139 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
124
522
  if (limit !== undefined) {
125
523
  localVarQueryParameter['limit'] = limit;
126
524
  }
525
+ localVarHeaderParameter['Accept'] = 'application/json';
526
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
527
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
528
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
529
+ return {
530
+ url: toPathString(localVarUrlObj),
531
+ options: localVarRequestOptions,
532
+ };
533
+ }),
534
+ /**
535
+ * Retrieve a paginated list of all objective weights for a specific value framework.
536
+ * @summary List all objective weights for a value framework
537
+ * @param {string} valueFrameworkId UUID of the value framework
538
+ * @param {number} [offset] Number of records to skip
539
+ * @param {number} [limit] Max number of records to return
540
+ * @param {*} [options] Override http request option.
541
+ * @throws {RequiredError}
542
+ */
543
+ getWeightsForValueFramework: (valueFrameworkId_1, offset_1, limit_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, offset_1, limit_1, ...args_1], void 0, function* (valueFrameworkId, offset, limit, options = {}) {
544
+ // verify required parameter 'valueFrameworkId' is not null or undefined
545
+ assertParamExists('getWeightsForValueFramework', 'valueFrameworkId', valueFrameworkId);
546
+ const localVarPath = `/value_framework/{value_framework_id}/weights/`
547
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
548
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
549
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
550
+ let baseOptions;
551
+ if (configuration) {
552
+ baseOptions = configuration.baseOptions;
553
+ }
554
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
555
+ const localVarHeaderParameter = {};
556
+ const localVarQueryParameter = {};
557
+ // authentication OAuth2AuthorizationCodeBearer required
558
+ // oauth required
559
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
560
+ if (offset !== undefined) {
561
+ localVarQueryParameter['offset'] = offset;
562
+ }
563
+ if (limit !== undefined) {
564
+ localVarQueryParameter['limit'] = limit;
565
+ }
566
+ localVarHeaderParameter['Accept'] = 'application/json';
567
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
568
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
569
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
570
+ return {
571
+ url: toPathString(localVarUrlObj),
572
+ options: localVarRequestOptions,
573
+ };
574
+ }),
575
+ /**
576
+ * Update the perceived and/or direct cost of a metric for a specific year within this framework.
577
+ * @summary Partially update metric costs for this framework
578
+ * @param {string} metricId UUID of the metric
579
+ * @param {number} year Year (1600-3000)
580
+ * @param {string} valueFrameworkId UUID of the value framework
581
+ * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
582
+ * @param {*} [options] Override http request option.
583
+ * @throws {RequiredError}
584
+ */
585
+ patchMetricCostForFramework: (metricId_1, year_1, valueFrameworkId_1, metricCostsPerYearUpdate_1, ...args_1) => __awaiter(this, [metricId_1, year_1, valueFrameworkId_1, metricCostsPerYearUpdate_1, ...args_1], void 0, function* (metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options = {}) {
586
+ // verify required parameter 'metricId' is not null or undefined
587
+ assertParamExists('patchMetricCostForFramework', 'metricId', metricId);
588
+ // verify required parameter 'year' is not null or undefined
589
+ assertParamExists('patchMetricCostForFramework', 'year', year);
590
+ // verify required parameter 'valueFrameworkId' is not null or undefined
591
+ assertParamExists('patchMetricCostForFramework', 'valueFrameworkId', valueFrameworkId);
592
+ // verify required parameter 'metricCostsPerYearUpdate' is not null or undefined
593
+ assertParamExists('patchMetricCostForFramework', 'metricCostsPerYearUpdate', metricCostsPerYearUpdate);
594
+ const localVarPath = `/value_framework/{value_framework_id}/metric_costs_per_year/{metric_id}/{year}`
595
+ .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
596
+ .replace(`{${"year"}}`, encodeURIComponent(String(year)))
597
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
598
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
599
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
600
+ let baseOptions;
601
+ if (configuration) {
602
+ baseOptions = configuration.baseOptions;
603
+ }
604
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
605
+ const localVarHeaderParameter = {};
606
+ const localVarQueryParameter = {};
607
+ // authentication OAuth2AuthorizationCodeBearer required
608
+ // oauth required
609
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
610
+ localVarHeaderParameter['Content-Type'] = 'application/json';
611
+ localVarHeaderParameter['Accept'] = 'application/json';
612
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
613
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
614
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
615
+ localVarRequestOptions.data = serializeDataIfNeeded(metricCostsPerYearUpdate, localVarRequestOptions, configuration);
616
+ return {
617
+ url: toPathString(localVarUrlObj),
618
+ options: localVarRequestOptions,
619
+ };
620
+ }),
621
+ /**
622
+ * Update the weight of an objective within this value framework.
623
+ * @summary Partially update an objective weight for this framework
624
+ * @param {string} objectiveId UUID of the objective
625
+ * @param {string} valueFrameworkId UUID of the value framework
626
+ * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
627
+ * @param {*} [options] Override http request option.
628
+ * @throws {RequiredError}
629
+ */
630
+ patchObjectiveWeightForFramework: (objectiveId_1, valueFrameworkId_1, objectiveWeightUpdate_1, ...args_1) => __awaiter(this, [objectiveId_1, valueFrameworkId_1, objectiveWeightUpdate_1, ...args_1], void 0, function* (objectiveId, valueFrameworkId, objectiveWeightUpdate, options = {}) {
631
+ // verify required parameter 'objectiveId' is not null or undefined
632
+ assertParamExists('patchObjectiveWeightForFramework', 'objectiveId', objectiveId);
633
+ // verify required parameter 'valueFrameworkId' is not null or undefined
634
+ assertParamExists('patchObjectiveWeightForFramework', 'valueFrameworkId', valueFrameworkId);
635
+ // verify required parameter 'objectiveWeightUpdate' is not null or undefined
636
+ assertParamExists('patchObjectiveWeightForFramework', 'objectiveWeightUpdate', objectiveWeightUpdate);
637
+ const localVarPath = `/value_framework/{value_framework_id}/objective_weight/{objective_id}`
638
+ .replace(`{${"objective_id"}}`, encodeURIComponent(String(objectiveId)))
639
+ .replace(`{${"value_framework_id"}}`, encodeURIComponent(String(valueFrameworkId)));
640
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
641
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
642
+ let baseOptions;
643
+ if (configuration) {
644
+ baseOptions = configuration.baseOptions;
645
+ }
646
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
647
+ const localVarHeaderParameter = {};
648
+ const localVarQueryParameter = {};
649
+ // authentication OAuth2AuthorizationCodeBearer required
650
+ // oauth required
651
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
652
+ localVarHeaderParameter['Content-Type'] = 'application/json';
653
+ localVarHeaderParameter['Accept'] = 'application/json';
127
654
  setSearchParams(localVarUrlObj, localVarQueryParameter);
128
655
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
129
656
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
657
+ localVarRequestOptions.data = serializeDataIfNeeded(objectiveWeightUpdate, localVarRequestOptions, configuration);
130
658
  return {
131
659
  url: toPathString(localVarUrlObj),
132
660
  options: localVarRequestOptions,
@@ -140,7 +668,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
140
668
  * @param {*} [options] Override http request option.
141
669
  * @throws {RequiredError}
142
670
  */
143
- patchValueFramework: (valueFrameworkId, valueFrameworkUpdate, options = {}) => __awaiter(this, void 0, void 0, function* () {
671
+ patchValueFramework: (valueFrameworkId_1, valueFrameworkUpdate_1, ...args_1) => __awaiter(this, [valueFrameworkId_1, valueFrameworkUpdate_1, ...args_1], void 0, function* (valueFrameworkId, valueFrameworkUpdate, options = {}) {
144
672
  // verify required parameter 'valueFrameworkId' is not null or undefined
145
673
  assertParamExists('patchValueFramework', 'valueFrameworkId', valueFrameworkId);
146
674
  // verify required parameter 'valueFrameworkUpdate' is not null or undefined
@@ -160,6 +688,7 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
160
688
  // oauth required
161
689
  yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
162
690
  localVarHeaderParameter['Content-Type'] = 'application/json';
691
+ localVarHeaderParameter['Accept'] = 'application/json';
163
692
  setSearchParams(localVarUrlObj, localVarQueryParameter);
164
693
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
165
694
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -170,61 +699,238 @@ export const ValueFrameworkApiAxiosParamCreator = function (configuration) {
170
699
  };
171
700
  }),
172
701
  /**
173
- * Create a new value framework. Name must be unique and non-empty.
174
- * @summary Create a value framework
175
- * @param {ValueFrameworkCreate} valueFrameworkCreate
702
+ * Create a new value framework. Name must be unique and non-empty.
703
+ * @summary Create a value framework
704
+ * @param {ValueFrameworkCreate} valueFrameworkCreate
705
+ * @param {*} [options] Override http request option.
706
+ * @throws {RequiredError}
707
+ */
708
+ postValueFramework: (valueFrameworkCreate_1, ...args_1) => __awaiter(this, [valueFrameworkCreate_1, ...args_1], void 0, function* (valueFrameworkCreate, options = {}) {
709
+ // verify required parameter 'valueFrameworkCreate' is not null or undefined
710
+ assertParamExists('postValueFramework', 'valueFrameworkCreate', valueFrameworkCreate);
711
+ const localVarPath = `/value_framework/`;
712
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
713
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
714
+ let baseOptions;
715
+ if (configuration) {
716
+ baseOptions = configuration.baseOptions;
717
+ }
718
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
719
+ const localVarHeaderParameter = {};
720
+ const localVarQueryParameter = {};
721
+ // authentication OAuth2AuthorizationCodeBearer required
722
+ // oauth required
723
+ yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
724
+ localVarHeaderParameter['Content-Type'] = 'application/json';
725
+ localVarHeaderParameter['Accept'] = 'application/json';
726
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
727
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
728
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
729
+ localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkCreate, localVarRequestOptions, configuration);
730
+ return {
731
+ url: toPathString(localVarUrlObj),
732
+ options: localVarRequestOptions,
733
+ };
734
+ }),
735
+ };
736
+ };
737
+ /**
738
+ * ValueFrameworkApi - functional programming interface
739
+ */
740
+ export const ValueFrameworkApiFp = function (configuration) {
741
+ const localVarAxiosParamCreator = ValueFrameworkApiAxiosParamCreator(configuration);
742
+ return {
743
+ /**
744
+ * Create a yearly cost override for a metric within this framework.
745
+ * @summary Create a yearly metric cost for this framework
746
+ * @param {string} valueFrameworkId UUID of the value framework
747
+ * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
748
+ * @param {*} [options] Override http request option.
749
+ * @throws {RequiredError}
750
+ */
751
+ createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options) {
752
+ return __awaiter(this, void 0, void 0, function* () {
753
+ var _a, _b, _c;
754
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options);
755
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
756
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.createMetricCostForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
757
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
758
+ });
759
+ },
760
+ /**
761
+ * Assign a weight to an objective within this framework.
762
+ * @summary Create an objective weight for this framework
763
+ * @param {string} valueFrameworkId UUID of the value framework
764
+ * @param {ObjectiveWeightCreate} objectiveWeightCreate
765
+ * @param {*} [options] Override http request option.
766
+ * @throws {RequiredError}
767
+ */
768
+ createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options) {
769
+ return __awaiter(this, void 0, void 0, function* () {
770
+ var _a, _b, _c;
771
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options);
772
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
773
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.createObjectiveWeightForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
774
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
775
+ });
776
+ },
777
+ /**
778
+ * Delete a metric cost entry for a specific year within this framework.
779
+ * @summary Delete metric costs for this framework
780
+ * @param {string} metricId UUID of the metric
781
+ * @param {number} year Year (1600-3000)
782
+ * @param {string} valueFrameworkId UUID of the value framework
783
+ * @param {*} [options] Override http request option.
784
+ * @throws {RequiredError}
785
+ */
786
+ deleteMetricCostForFramework(metricId, year, valueFrameworkId, options) {
787
+ return __awaiter(this, void 0, void 0, function* () {
788
+ var _a, _b, _c;
789
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteMetricCostForFramework(metricId, year, valueFrameworkId, options);
790
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
791
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.deleteMetricCostForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
792
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
793
+ });
794
+ },
795
+ /**
796
+ * Remove an objective weight from this framework.
797
+ * @summary Delete an objective weight for this framework
798
+ * @param {string} objectiveId UUID of the objective
799
+ * @param {string} valueFrameworkId UUID of the value framework
800
+ * @param {*} [options] Override http request option.
801
+ * @throws {RequiredError}
802
+ */
803
+ deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options) {
804
+ return __awaiter(this, void 0, void 0, function* () {
805
+ var _a, _b, _c;
806
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options);
807
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
808
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.deleteObjectiveWeightForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
809
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
810
+ });
811
+ },
812
+ /**
813
+ * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
814
+ * @summary Delete a value framework
815
+ * @param {string} valueFrameworkId UUID of the value framework
816
+ * @param {*} [options] Override http request option.
817
+ * @throws {RequiredError}
818
+ */
819
+ deleteValueFramework(valueFrameworkId, options) {
820
+ return __awaiter(this, void 0, void 0, function* () {
821
+ var _a, _b, _c;
822
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteValueFramework(valueFrameworkId, options);
823
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
824
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.deleteValueFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
825
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
826
+ });
827
+ },
828
+ /**
829
+ * Retrieve a paginated list of all metric costs for a specific value framework.
830
+ * @summary List all metric costs for a value framework
831
+ * @param {string} valueFrameworkId UUID of the value framework
832
+ * @param {number} [offset] Number of records to skip
833
+ * @param {number} [limit] Max number of records to return
834
+ * @param {*} [options] Override http request option.
835
+ * @throws {RequiredError}
836
+ */
837
+ getCostsForValueFramework(valueFrameworkId, offset, limit, options) {
838
+ return __awaiter(this, void 0, void 0, function* () {
839
+ var _a, _b, _c;
840
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getCostsForValueFramework(valueFrameworkId, offset, limit, options);
841
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
842
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getCostsForValueFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
843
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
844
+ });
845
+ },
846
+ /**
847
+ * Retrieve a paginated list of metric costs for a specific metric within a value framework.
848
+ * @summary List metric costs for a value framework filtered by metric
849
+ * @param {string} metricId UUID of the metric
850
+ * @param {string} valueFrameworkId UUID of the value framework
851
+ * @param {number} [offset] Number of records to skip
852
+ * @param {number} [limit] Max number of records to return
853
+ * @param {*} [options] Override http request option.
854
+ * @throws {RequiredError}
855
+ */
856
+ getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options) {
857
+ return __awaiter(this, void 0, void 0, function* () {
858
+ var _a, _b, _c;
859
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options);
860
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
861
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getCostsForValueFrameworkByMetric']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
862
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
863
+ });
864
+ },
865
+ /**
866
+ * Retrieve cost data for a specific metric within this framework for a given year.
867
+ * @summary Get a yearly metric cost for this framework
868
+ * @param {string} metricId UUID of the metric
869
+ * @param {number} year Year (1600-3000)
870
+ * @param {string} valueFrameworkId UUID of the value framework
871
+ * @param {*} [options] Override http request option.
872
+ * @throws {RequiredError}
873
+ */
874
+ getMetricCostForFramework(metricId, year, valueFrameworkId, options) {
875
+ return __awaiter(this, void 0, void 0, function* () {
876
+ var _a, _b, _c;
877
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricCostForFramework(metricId, year, valueFrameworkId, options);
878
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
879
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getMetricCostForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
880
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
881
+ });
882
+ },
883
+ /**
884
+ * Retrieve a paginated list of all yearly metric costs for a specific framework.
885
+ * @summary List yearly metric costs for this framework
886
+ * @param {string} valueFrameworkId UUID of the value framework
887
+ * @param {number} [offset] Number of records to skip
888
+ * @param {number} [limit] Max number of records to return
889
+ * @param {*} [options] Override http request option.
890
+ * @throws {RequiredError}
891
+ */
892
+ getMetricCostsForFramework(valueFrameworkId, offset, limit, options) {
893
+ return __awaiter(this, void 0, void 0, function* () {
894
+ var _a, _b, _c;
895
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getMetricCostsForFramework(valueFrameworkId, offset, limit, options);
896
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
897
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getMetricCostsForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
898
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
899
+ });
900
+ },
901
+ /**
902
+ * Retrieve the weight for a specific objective within this framework.
903
+ * @summary Get an objective weight for this framework
904
+ * @param {string} objectiveId UUID of the objective
905
+ * @param {string} valueFrameworkId UUID of the value framework
176
906
  * @param {*} [options] Override http request option.
177
907
  * @throws {RequiredError}
178
908
  */
179
- postValueFramework: (valueFrameworkCreate, options = {}) => __awaiter(this, void 0, void 0, function* () {
180
- // verify required parameter 'valueFrameworkCreate' is not null or undefined
181
- assertParamExists('postValueFramework', 'valueFrameworkCreate', valueFrameworkCreate);
182
- const localVarPath = `/value_framework/`;
183
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
184
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
185
- let baseOptions;
186
- if (configuration) {
187
- baseOptions = configuration.baseOptions;
188
- }
189
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
190
- const localVarHeaderParameter = {};
191
- const localVarQueryParameter = {};
192
- // authentication OAuth2AuthorizationCodeBearer required
193
- // oauth required
194
- yield setOAuthToObject(localVarHeaderParameter, "OAuth2AuthorizationCodeBearer", [], configuration);
195
- localVarHeaderParameter['Content-Type'] = 'application/json';
196
- setSearchParams(localVarUrlObj, localVarQueryParameter);
197
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
198
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
199
- localVarRequestOptions.data = serializeDataIfNeeded(valueFrameworkCreate, localVarRequestOptions, configuration);
200
- return {
201
- url: toPathString(localVarUrlObj),
202
- options: localVarRequestOptions,
203
- };
204
- }),
205
- };
206
- };
207
- /**
208
- * ValueFrameworkApi - functional programming interface
209
- * @export
210
- */
211
- export const ValueFrameworkApiFp = function (configuration) {
212
- const localVarAxiosParamCreator = ValueFrameworkApiAxiosParamCreator(configuration);
213
- return {
909
+ getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options) {
910
+ return __awaiter(this, void 0, void 0, function* () {
911
+ var _a, _b, _c;
912
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options);
913
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
914
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getObjectiveWeightForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
915
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
916
+ });
917
+ },
214
918
  /**
215
- * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
216
- * @summary Delete a value framework
919
+ * Retrieve a paginated list of all objective weights for a specific framework.
920
+ * @summary List objective weights for this framework
217
921
  * @param {string} valueFrameworkId UUID of the value framework
922
+ * @param {number} [offset] Number of records to skip
923
+ * @param {number} [limit] Max number of records to return
218
924
  * @param {*} [options] Override http request option.
219
925
  * @throws {RequiredError}
220
926
  */
221
- deleteValueFramework(valueFrameworkId, options) {
222
- var _a, _b, _c;
927
+ getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options) {
223
928
  return __awaiter(this, void 0, void 0, function* () {
224
- const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteValueFramework(valueFrameworkId, options);
225
- const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
226
- const operationBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.deleteValueFramework']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
227
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
929
+ var _a, _b, _c;
930
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options);
931
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
932
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getObjectiveWeightsForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
933
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
228
934
  });
229
935
  },
230
936
  /**
@@ -235,12 +941,12 @@ export const ValueFrameworkApiFp = function (configuration) {
235
941
  * @throws {RequiredError}
236
942
  */
237
943
  getValueFrameworkById(valueFrameworkId, options) {
238
- var _a, _b, _c;
239
944
  return __awaiter(this, void 0, void 0, function* () {
945
+ var _a, _b, _c;
240
946
  const localVarAxiosArgs = yield localVarAxiosParamCreator.getValueFrameworkById(valueFrameworkId, options);
241
- const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
242
- const operationBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getValueFrameworkById']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
243
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
947
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
948
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getValueFrameworkById']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
949
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
244
950
  });
245
951
  },
246
952
  /**
@@ -252,12 +958,67 @@ export const ValueFrameworkApiFp = function (configuration) {
252
958
  * @throws {RequiredError}
253
959
  */
254
960
  getValueFrameworks(offset, limit, options) {
255
- var _a, _b, _c;
256
961
  return __awaiter(this, void 0, void 0, function* () {
962
+ var _a, _b, _c;
257
963
  const localVarAxiosArgs = yield localVarAxiosParamCreator.getValueFrameworks(offset, limit, options);
258
- const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
259
- const operationBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getValueFrameworks']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
260
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
964
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
965
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getValueFrameworks']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
966
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
967
+ });
968
+ },
969
+ /**
970
+ * Retrieve a paginated list of all objective weights for a specific value framework.
971
+ * @summary List all objective weights for a value framework
972
+ * @param {string} valueFrameworkId UUID of the value framework
973
+ * @param {number} [offset] Number of records to skip
974
+ * @param {number} [limit] Max number of records to return
975
+ * @param {*} [options] Override http request option.
976
+ * @throws {RequiredError}
977
+ */
978
+ getWeightsForValueFramework(valueFrameworkId, offset, limit, options) {
979
+ return __awaiter(this, void 0, void 0, function* () {
980
+ var _a, _b, _c;
981
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getWeightsForValueFramework(valueFrameworkId, offset, limit, options);
982
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
983
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.getWeightsForValueFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
984
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
985
+ });
986
+ },
987
+ /**
988
+ * Update the perceived and/or direct cost of a metric for a specific year within this framework.
989
+ * @summary Partially update metric costs for this framework
990
+ * @param {string} metricId UUID of the metric
991
+ * @param {number} year Year (1600-3000)
992
+ * @param {string} valueFrameworkId UUID of the value framework
993
+ * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
994
+ * @param {*} [options] Override http request option.
995
+ * @throws {RequiredError}
996
+ */
997
+ patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options) {
998
+ return __awaiter(this, void 0, void 0, function* () {
999
+ var _a, _b, _c;
1000
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options);
1001
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1002
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.patchMetricCostForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1003
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1004
+ });
1005
+ },
1006
+ /**
1007
+ * Update the weight of an objective within this value framework.
1008
+ * @summary Partially update an objective weight for this framework
1009
+ * @param {string} objectiveId UUID of the objective
1010
+ * @param {string} valueFrameworkId UUID of the value framework
1011
+ * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
1012
+ * @param {*} [options] Override http request option.
1013
+ * @throws {RequiredError}
1014
+ */
1015
+ patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options) {
1016
+ return __awaiter(this, void 0, void 0, function* () {
1017
+ var _a, _b, _c;
1018
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options);
1019
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1020
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.patchObjectiveWeightForFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1021
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
261
1022
  });
262
1023
  },
263
1024
  /**
@@ -269,12 +1030,12 @@ export const ValueFrameworkApiFp = function (configuration) {
269
1030
  * @throws {RequiredError}
270
1031
  */
271
1032
  patchValueFramework(valueFrameworkId, valueFrameworkUpdate, options) {
272
- var _a, _b, _c;
273
1033
  return __awaiter(this, void 0, void 0, function* () {
1034
+ var _a, _b, _c;
274
1035
  const localVarAxiosArgs = yield localVarAxiosParamCreator.patchValueFramework(valueFrameworkId, valueFrameworkUpdate, options);
275
- const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
276
- const operationBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.patchValueFramework']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
277
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
1036
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1037
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.patchValueFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1038
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
278
1039
  });
279
1040
  },
280
1041
  /**
@@ -285,23 +1046,67 @@ export const ValueFrameworkApiFp = function (configuration) {
285
1046
  * @throws {RequiredError}
286
1047
  */
287
1048
  postValueFramework(valueFrameworkCreate, options) {
288
- var _a, _b, _c;
289
1049
  return __awaiter(this, void 0, void 0, function* () {
1050
+ var _a, _b, _c;
290
1051
  const localVarAxiosArgs = yield localVarAxiosParamCreator.postValueFramework(valueFrameworkCreate, options);
291
- const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
292
- const operationBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.postValueFramework']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
293
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
1052
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1053
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ValueFrameworkApi.postValueFramework']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1054
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
294
1055
  });
295
1056
  },
296
1057
  };
297
1058
  };
298
1059
  /**
299
1060
  * ValueFrameworkApi - factory interface
300
- * @export
301
1061
  */
302
1062
  export const ValueFrameworkApiFactory = function (configuration, basePath, axios) {
303
1063
  const localVarFp = ValueFrameworkApiFp(configuration);
304
1064
  return {
1065
+ /**
1066
+ * Create a yearly cost override for a metric within this framework.
1067
+ * @summary Create a yearly metric cost for this framework
1068
+ * @param {string} valueFrameworkId UUID of the value framework
1069
+ * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
1070
+ * @param {*} [options] Override http request option.
1071
+ * @throws {RequiredError}
1072
+ */
1073
+ createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options) {
1074
+ return localVarFp.createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options).then((request) => request(axios, basePath));
1075
+ },
1076
+ /**
1077
+ * Assign a weight to an objective within this framework.
1078
+ * @summary Create an objective weight for this framework
1079
+ * @param {string} valueFrameworkId UUID of the value framework
1080
+ * @param {ObjectiveWeightCreate} objectiveWeightCreate
1081
+ * @param {*} [options] Override http request option.
1082
+ * @throws {RequiredError}
1083
+ */
1084
+ createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options) {
1085
+ return localVarFp.createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options).then((request) => request(axios, basePath));
1086
+ },
1087
+ /**
1088
+ * Delete a metric cost entry for a specific year within this framework.
1089
+ * @summary Delete metric costs for this framework
1090
+ * @param {string} metricId UUID of the metric
1091
+ * @param {number} year Year (1600-3000)
1092
+ * @param {string} valueFrameworkId UUID of the value framework
1093
+ * @param {*} [options] Override http request option.
1094
+ * @throws {RequiredError}
1095
+ */
1096
+ deleteMetricCostForFramework(metricId, year, valueFrameworkId, options) {
1097
+ return localVarFp.deleteMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(axios, basePath));
1098
+ },
1099
+ /**
1100
+ * Remove an objective weight from this framework.
1101
+ * @summary Delete an objective weight for this framework
1102
+ * @param {string} objectiveId UUID of the objective
1103
+ * @param {string} valueFrameworkId UUID of the value framework
1104
+ * @param {*} [options] Override http request option.
1105
+ * @throws {RequiredError}
1106
+ */
1107
+ deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options) {
1108
+ return localVarFp.deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(axios, basePath));
1109
+ },
305
1110
  /**
306
1111
  * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
307
1112
  * @summary Delete a value framework
@@ -312,6 +1117,78 @@ export const ValueFrameworkApiFactory = function (configuration, basePath, axios
312
1117
  deleteValueFramework(valueFrameworkId, options) {
313
1118
  return localVarFp.deleteValueFramework(valueFrameworkId, options).then((request) => request(axios, basePath));
314
1119
  },
1120
+ /**
1121
+ * Retrieve a paginated list of all metric costs for a specific value framework.
1122
+ * @summary List all metric costs for a value framework
1123
+ * @param {string} valueFrameworkId UUID of the value framework
1124
+ * @param {number} [offset] Number of records to skip
1125
+ * @param {number} [limit] Max number of records to return
1126
+ * @param {*} [options] Override http request option.
1127
+ * @throws {RequiredError}
1128
+ */
1129
+ getCostsForValueFramework(valueFrameworkId, offset, limit, options) {
1130
+ return localVarFp.getCostsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1131
+ },
1132
+ /**
1133
+ * Retrieve a paginated list of metric costs for a specific metric within a value framework.
1134
+ * @summary List metric costs for a value framework filtered by metric
1135
+ * @param {string} metricId UUID of the metric
1136
+ * @param {string} valueFrameworkId UUID of the value framework
1137
+ * @param {number} [offset] Number of records to skip
1138
+ * @param {number} [limit] Max number of records to return
1139
+ * @param {*} [options] Override http request option.
1140
+ * @throws {RequiredError}
1141
+ */
1142
+ getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options) {
1143
+ return localVarFp.getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1144
+ },
1145
+ /**
1146
+ * Retrieve cost data for a specific metric within this framework for a given year.
1147
+ * @summary Get a yearly metric cost for this framework
1148
+ * @param {string} metricId UUID of the metric
1149
+ * @param {number} year Year (1600-3000)
1150
+ * @param {string} valueFrameworkId UUID of the value framework
1151
+ * @param {*} [options] Override http request option.
1152
+ * @throws {RequiredError}
1153
+ */
1154
+ getMetricCostForFramework(metricId, year, valueFrameworkId, options) {
1155
+ return localVarFp.getMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(axios, basePath));
1156
+ },
1157
+ /**
1158
+ * Retrieve a paginated list of all yearly metric costs for a specific framework.
1159
+ * @summary List yearly metric costs for this framework
1160
+ * @param {string} valueFrameworkId UUID of the value framework
1161
+ * @param {number} [offset] Number of records to skip
1162
+ * @param {number} [limit] Max number of records to return
1163
+ * @param {*} [options] Override http request option.
1164
+ * @throws {RequiredError}
1165
+ */
1166
+ getMetricCostsForFramework(valueFrameworkId, offset, limit, options) {
1167
+ return localVarFp.getMetricCostsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1168
+ },
1169
+ /**
1170
+ * Retrieve the weight for a specific objective within this framework.
1171
+ * @summary Get an objective weight for this framework
1172
+ * @param {string} objectiveId UUID of the objective
1173
+ * @param {string} valueFrameworkId UUID of the value framework
1174
+ * @param {*} [options] Override http request option.
1175
+ * @throws {RequiredError}
1176
+ */
1177
+ getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options) {
1178
+ return localVarFp.getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(axios, basePath));
1179
+ },
1180
+ /**
1181
+ * Retrieve a paginated list of all objective weights for a specific framework.
1182
+ * @summary List objective weights for this framework
1183
+ * @param {string} valueFrameworkId UUID of the value framework
1184
+ * @param {number} [offset] Number of records to skip
1185
+ * @param {number} [limit] Max number of records to return
1186
+ * @param {*} [options] Override http request option.
1187
+ * @throws {RequiredError}
1188
+ */
1189
+ getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options) {
1190
+ return localVarFp.getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1191
+ },
315
1192
  /**
316
1193
  * Retrieve a single value framework by its ID.
317
1194
  * @summary Get a value framework by ID
@@ -333,6 +1210,43 @@ export const ValueFrameworkApiFactory = function (configuration, basePath, axios
333
1210
  getValueFrameworks(offset, limit, options) {
334
1211
  return localVarFp.getValueFrameworks(offset, limit, options).then((request) => request(axios, basePath));
335
1212
  },
1213
+ /**
1214
+ * Retrieve a paginated list of all objective weights for a specific value framework.
1215
+ * @summary List all objective weights for a value framework
1216
+ * @param {string} valueFrameworkId UUID of the value framework
1217
+ * @param {number} [offset] Number of records to skip
1218
+ * @param {number} [limit] Max number of records to return
1219
+ * @param {*} [options] Override http request option.
1220
+ * @throws {RequiredError}
1221
+ */
1222
+ getWeightsForValueFramework(valueFrameworkId, offset, limit, options) {
1223
+ return localVarFp.getWeightsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(axios, basePath));
1224
+ },
1225
+ /**
1226
+ * Update the perceived and/or direct cost of a metric for a specific year within this framework.
1227
+ * @summary Partially update metric costs for this framework
1228
+ * @param {string} metricId UUID of the metric
1229
+ * @param {number} year Year (1600-3000)
1230
+ * @param {string} valueFrameworkId UUID of the value framework
1231
+ * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
1232
+ * @param {*} [options] Override http request option.
1233
+ * @throws {RequiredError}
1234
+ */
1235
+ patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options) {
1236
+ return localVarFp.patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(axios, basePath));
1237
+ },
1238
+ /**
1239
+ * Update the weight of an objective within this value framework.
1240
+ * @summary Partially update an objective weight for this framework
1241
+ * @param {string} objectiveId UUID of the objective
1242
+ * @param {string} valueFrameworkId UUID of the value framework
1243
+ * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
1244
+ * @param {*} [options] Override http request option.
1245
+ * @throws {RequiredError}
1246
+ */
1247
+ patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options) {
1248
+ return localVarFp.patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options).then((request) => request(axios, basePath));
1249
+ },
336
1250
  /**
337
1251
  * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
338
1252
  * @summary Partially update a value framework
@@ -358,29 +1272,141 @@ export const ValueFrameworkApiFactory = function (configuration, basePath, axios
358
1272
  };
359
1273
  /**
360
1274
  * ValueFrameworkApi - object-oriented interface
361
- * @export
362
- * @class ValueFrameworkApi
363
- * @extends {BaseAPI}
364
1275
  */
365
1276
  export class ValueFrameworkApi extends BaseAPI {
1277
+ /**
1278
+ * Create a yearly cost override for a metric within this framework.
1279
+ * @summary Create a yearly metric cost for this framework
1280
+ * @param {string} valueFrameworkId UUID of the value framework
1281
+ * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
1282
+ * @param {*} [options] Override http request option.
1283
+ * @throws {RequiredError}
1284
+ */
1285
+ createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options) {
1286
+ return ValueFrameworkApiFp(this.configuration).createMetricCostForFramework(valueFrameworkId, metricCostsPerYearCreate, options).then((request) => request(this.axios, this.basePath));
1287
+ }
1288
+ /**
1289
+ * Assign a weight to an objective within this framework.
1290
+ * @summary Create an objective weight for this framework
1291
+ * @param {string} valueFrameworkId UUID of the value framework
1292
+ * @param {ObjectiveWeightCreate} objectiveWeightCreate
1293
+ * @param {*} [options] Override http request option.
1294
+ * @throws {RequiredError}
1295
+ */
1296
+ createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options) {
1297
+ return ValueFrameworkApiFp(this.configuration).createObjectiveWeightForFramework(valueFrameworkId, objectiveWeightCreate, options).then((request) => request(this.axios, this.basePath));
1298
+ }
1299
+ /**
1300
+ * Delete a metric cost entry for a specific year within this framework.
1301
+ * @summary Delete metric costs for this framework
1302
+ * @param {string} metricId UUID of the metric
1303
+ * @param {number} year Year (1600-3000)
1304
+ * @param {string} valueFrameworkId UUID of the value framework
1305
+ * @param {*} [options] Override http request option.
1306
+ * @throws {RequiredError}
1307
+ */
1308
+ deleteMetricCostForFramework(metricId, year, valueFrameworkId, options) {
1309
+ return ValueFrameworkApiFp(this.configuration).deleteMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1310
+ }
1311
+ /**
1312
+ * Remove an objective weight from this framework.
1313
+ * @summary Delete an objective weight for this framework
1314
+ * @param {string} objectiveId UUID of the objective
1315
+ * @param {string} valueFrameworkId UUID of the value framework
1316
+ * @param {*} [options] Override http request option.
1317
+ * @throws {RequiredError}
1318
+ */
1319
+ deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options) {
1320
+ return ValueFrameworkApiFp(this.configuration).deleteObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1321
+ }
366
1322
  /**
367
1323
  * Delete an existing value framework by its ID. Associated objective weights and metric costs per year are also deleted via cascade.
368
1324
  * @summary Delete a value framework
369
1325
  * @param {string} valueFrameworkId UUID of the value framework
370
1326
  * @param {*} [options] Override http request option.
371
1327
  * @throws {RequiredError}
372
- * @memberof ValueFrameworkApi
373
1328
  */
374
1329
  deleteValueFramework(valueFrameworkId, options) {
375
1330
  return ValueFrameworkApiFp(this.configuration).deleteValueFramework(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
376
1331
  }
1332
+ /**
1333
+ * Retrieve a paginated list of all metric costs for a specific value framework.
1334
+ * @summary List all metric costs for a value framework
1335
+ * @param {string} valueFrameworkId UUID of the value framework
1336
+ * @param {number} [offset] Number of records to skip
1337
+ * @param {number} [limit] Max number of records to return
1338
+ * @param {*} [options] Override http request option.
1339
+ * @throws {RequiredError}
1340
+ */
1341
+ getCostsForValueFramework(valueFrameworkId, offset, limit, options) {
1342
+ return ValueFrameworkApiFp(this.configuration).getCostsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1343
+ }
1344
+ /**
1345
+ * Retrieve a paginated list of metric costs for a specific metric within a value framework.
1346
+ * @summary List metric costs for a value framework filtered by metric
1347
+ * @param {string} metricId UUID of the metric
1348
+ * @param {string} valueFrameworkId UUID of the value framework
1349
+ * @param {number} [offset] Number of records to skip
1350
+ * @param {number} [limit] Max number of records to return
1351
+ * @param {*} [options] Override http request option.
1352
+ * @throws {RequiredError}
1353
+ */
1354
+ getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options) {
1355
+ return ValueFrameworkApiFp(this.configuration).getCostsForValueFrameworkByMetric(metricId, valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1356
+ }
1357
+ /**
1358
+ * Retrieve cost data for a specific metric within this framework for a given year.
1359
+ * @summary Get a yearly metric cost for this framework
1360
+ * @param {string} metricId UUID of the metric
1361
+ * @param {number} year Year (1600-3000)
1362
+ * @param {string} valueFrameworkId UUID of the value framework
1363
+ * @param {*} [options] Override http request option.
1364
+ * @throws {RequiredError}
1365
+ */
1366
+ getMetricCostForFramework(metricId, year, valueFrameworkId, options) {
1367
+ return ValueFrameworkApiFp(this.configuration).getMetricCostForFramework(metricId, year, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1368
+ }
1369
+ /**
1370
+ * Retrieve a paginated list of all yearly metric costs for a specific framework.
1371
+ * @summary List yearly metric costs for this framework
1372
+ * @param {string} valueFrameworkId UUID of the value framework
1373
+ * @param {number} [offset] Number of records to skip
1374
+ * @param {number} [limit] Max number of records to return
1375
+ * @param {*} [options] Override http request option.
1376
+ * @throws {RequiredError}
1377
+ */
1378
+ getMetricCostsForFramework(valueFrameworkId, offset, limit, options) {
1379
+ return ValueFrameworkApiFp(this.configuration).getMetricCostsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1380
+ }
1381
+ /**
1382
+ * Retrieve the weight for a specific objective within this framework.
1383
+ * @summary Get an objective weight for this framework
1384
+ * @param {string} objectiveId UUID of the objective
1385
+ * @param {string} valueFrameworkId UUID of the value framework
1386
+ * @param {*} [options] Override http request option.
1387
+ * @throws {RequiredError}
1388
+ */
1389
+ getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options) {
1390
+ return ValueFrameworkApiFp(this.configuration).getObjectiveWeightForFramework(objectiveId, valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
1391
+ }
1392
+ /**
1393
+ * Retrieve a paginated list of all objective weights for a specific framework.
1394
+ * @summary List objective weights for this framework
1395
+ * @param {string} valueFrameworkId UUID of the value framework
1396
+ * @param {number} [offset] Number of records to skip
1397
+ * @param {number} [limit] Max number of records to return
1398
+ * @param {*} [options] Override http request option.
1399
+ * @throws {RequiredError}
1400
+ */
1401
+ getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options) {
1402
+ return ValueFrameworkApiFp(this.configuration).getObjectiveWeightsForFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1403
+ }
377
1404
  /**
378
1405
  * Retrieve a single value framework by its ID.
379
1406
  * @summary Get a value framework by ID
380
1407
  * @param {string} valueFrameworkId UUID of the value framework
381
1408
  * @param {*} [options] Override http request option.
382
1409
  * @throws {RequiredError}
383
- * @memberof ValueFrameworkApi
384
1410
  */
385
1411
  getValueFrameworkById(valueFrameworkId, options) {
386
1412
  return ValueFrameworkApiFp(this.configuration).getValueFrameworkById(valueFrameworkId, options).then((request) => request(this.axios, this.basePath));
@@ -392,11 +1418,47 @@ export class ValueFrameworkApi extends BaseAPI {
392
1418
  * @param {number} [limit] Max number of records to return
393
1419
  * @param {*} [options] Override http request option.
394
1420
  * @throws {RequiredError}
395
- * @memberof ValueFrameworkApi
396
1421
  */
397
1422
  getValueFrameworks(offset, limit, options) {
398
1423
  return ValueFrameworkApiFp(this.configuration).getValueFrameworks(offset, limit, options).then((request) => request(this.axios, this.basePath));
399
1424
  }
1425
+ /**
1426
+ * Retrieve a paginated list of all objective weights for a specific value framework.
1427
+ * @summary List all objective weights for a value framework
1428
+ * @param {string} valueFrameworkId UUID of the value framework
1429
+ * @param {number} [offset] Number of records to skip
1430
+ * @param {number} [limit] Max number of records to return
1431
+ * @param {*} [options] Override http request option.
1432
+ * @throws {RequiredError}
1433
+ */
1434
+ getWeightsForValueFramework(valueFrameworkId, offset, limit, options) {
1435
+ return ValueFrameworkApiFp(this.configuration).getWeightsForValueFramework(valueFrameworkId, offset, limit, options).then((request) => request(this.axios, this.basePath));
1436
+ }
1437
+ /**
1438
+ * Update the perceived and/or direct cost of a metric for a specific year within this framework.
1439
+ * @summary Partially update metric costs for this framework
1440
+ * @param {string} metricId UUID of the metric
1441
+ * @param {number} year Year (1600-3000)
1442
+ * @param {string} valueFrameworkId UUID of the value framework
1443
+ * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
1444
+ * @param {*} [options] Override http request option.
1445
+ * @throws {RequiredError}
1446
+ */
1447
+ patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options) {
1448
+ return ValueFrameworkApiFp(this.configuration).patchMetricCostForFramework(metricId, year, valueFrameworkId, metricCostsPerYearUpdate, options).then((request) => request(this.axios, this.basePath));
1449
+ }
1450
+ /**
1451
+ * Update the weight of an objective within this value framework.
1452
+ * @summary Partially update an objective weight for this framework
1453
+ * @param {string} objectiveId UUID of the objective
1454
+ * @param {string} valueFrameworkId UUID of the value framework
1455
+ * @param {ObjectiveWeightUpdate} objectiveWeightUpdate
1456
+ * @param {*} [options] Override http request option.
1457
+ * @throws {RequiredError}
1458
+ */
1459
+ patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options) {
1460
+ return ValueFrameworkApiFp(this.configuration).patchObjectiveWeightForFramework(objectiveId, valueFrameworkId, objectiveWeightUpdate, options).then((request) => request(this.axios, this.basePath));
1461
+ }
400
1462
  /**
401
1463
  * Update one or more fields of an existing value framework. Only the fields included in the request body will be modified; omitted fields remain unchanged.
402
1464
  * @summary Partially update a value framework
@@ -404,7 +1466,6 @@ export class ValueFrameworkApi extends BaseAPI {
404
1466
  * @param {ValueFrameworkUpdate} valueFrameworkUpdate
405
1467
  * @param {*} [options] Override http request option.
406
1468
  * @throws {RequiredError}
407
- * @memberof ValueFrameworkApi
408
1469
  */
409
1470
  patchValueFramework(valueFrameworkId, valueFrameworkUpdate, options) {
410
1471
  return ValueFrameworkApiFp(this.configuration).patchValueFramework(valueFrameworkId, valueFrameworkUpdate, options).then((request) => request(this.axios, this.basePath));
@@ -415,7 +1476,6 @@ export class ValueFrameworkApi extends BaseAPI {
415
1476
  * @param {ValueFrameworkCreate} valueFrameworkCreate
416
1477
  * @param {*} [options] Override http request option.
417
1478
  * @throws {RequiredError}
418
- * @memberof ValueFrameworkApi
419
1479
  */
420
1480
  postValueFramework(valueFrameworkCreate, options) {
421
1481
  return ValueFrameworkApiFp(this.configuration).postValueFramework(valueFrameworkCreate, options).then((request) => request(this.axios, this.basePath));