@cosmotech/aip-client 0.1.0-rc1 → 0.2.0-dev

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.
@@ -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.1.0-rc1
7
+ * The version of the OpenAPI document: 0.2.0-dev
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -42,13 +42,13 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
42
42
  * @param {*} [options] Override http request option.
43
43
  * @throws {RequiredError}
44
44
  */
45
- deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete: async (metricId: string, frameworkId: string, year: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
45
+ deleteMetricCost: async (metricId: string, frameworkId: string, year: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
46
46
  // verify required parameter 'metricId' is not null or undefined
47
- assertParamExists('deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete', 'metricId', metricId)
47
+ assertParamExists('deleteMetricCost', 'metricId', metricId)
48
48
  // verify required parameter 'frameworkId' is not null or undefined
49
- assertParamExists('deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete', 'frameworkId', frameworkId)
49
+ assertParamExists('deleteMetricCost', 'frameworkId', frameworkId)
50
50
  // verify required parameter 'year' is not null or undefined
51
- assertParamExists('deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete', 'year', year)
51
+ assertParamExists('deleteMetricCost', 'year', year)
52
52
  const localVarPath = `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`
53
53
  .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
54
54
  .replace(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
@@ -88,13 +88,13 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
88
88
  * @param {*} [options] Override http request option.
89
89
  * @throws {RequiredError}
90
90
  */
91
- getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet: async (metricId: string, frameworkId: string, year: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
91
+ getMetricCostByKeys: async (metricId: string, frameworkId: string, year: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
92
92
  // verify required parameter 'metricId' is not null or undefined
93
- assertParamExists('getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet', 'metricId', metricId)
93
+ assertParamExists('getMetricCostByKeys', 'metricId', metricId)
94
94
  // verify required parameter 'frameworkId' is not null or undefined
95
- assertParamExists('getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet', 'frameworkId', frameworkId)
95
+ assertParamExists('getMetricCostByKeys', 'frameworkId', frameworkId)
96
96
  // verify required parameter 'year' is not null or undefined
97
- assertParamExists('getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet', 'year', year)
97
+ assertParamExists('getMetricCostByKeys', 'year', year)
98
98
  const localVarPath = `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`
99
99
  .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
100
100
  .replace(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
@@ -133,7 +133,7 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
133
133
  * @param {*} [options] Override http request option.
134
134
  * @throws {RequiredError}
135
135
  */
136
- getMetricCostsMetricCostsPerYearGet: async (offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
136
+ getMetricCosts: async (offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
137
137
  const localVarPath = `/metric_costs_per_year/`;
138
138
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
139
139
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -179,15 +179,15 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
179
179
  * @param {*} [options] Override http request option.
180
180
  * @throws {RequiredError}
181
181
  */
182
- patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch: async (metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
182
+ patchMetricCost: async (metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
183
183
  // verify required parameter 'metricId' is not null or undefined
184
- assertParamExists('patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch', 'metricId', metricId)
184
+ assertParamExists('patchMetricCost', 'metricId', metricId)
185
185
  // verify required parameter 'frameworkId' is not null or undefined
186
- assertParamExists('patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch', 'frameworkId', frameworkId)
186
+ assertParamExists('patchMetricCost', 'frameworkId', frameworkId)
187
187
  // verify required parameter 'year' is not null or undefined
188
- assertParamExists('patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch', 'year', year)
188
+ assertParamExists('patchMetricCost', 'year', year)
189
189
  // verify required parameter 'metricCostsPerYearUpdate' is not null or undefined
190
- assertParamExists('patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch', 'metricCostsPerYearUpdate', metricCostsPerYearUpdate)
190
+ assertParamExists('patchMetricCost', 'metricCostsPerYearUpdate', metricCostsPerYearUpdate)
191
191
  const localVarPath = `/metric_costs_per_year/{metric_id}/{framework_id}/{year}`
192
192
  .replace(`{${"metric_id"}}`, encodeURIComponent(String(metricId)))
193
193
  .replace(`{${"framework_id"}}`, encodeURIComponent(String(frameworkId)))
@@ -228,9 +228,9 @@ export const MetricCostsPerYearApiAxiosParamCreator = function (configuration?:
228
228
  * @param {*} [options] Override http request option.
229
229
  * @throws {RequiredError}
230
230
  */
231
- postMetricCostMetricCostsPerYearPost: async (metricCostsPerYearCreate: MetricCostsPerYearCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
231
+ postMetricCost: async (metricCostsPerYearCreate: MetricCostsPerYearCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
232
232
  // verify required parameter 'metricCostsPerYearCreate' is not null or undefined
233
- assertParamExists('postMetricCostMetricCostsPerYearPost', 'metricCostsPerYearCreate', metricCostsPerYearCreate)
233
+ assertParamExists('postMetricCost', 'metricCostsPerYearCreate', metricCostsPerYearCreate)
234
234
  const localVarPath = `/metric_costs_per_year/`;
235
235
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
236
236
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -280,10 +280,10 @@ export const MetricCostsPerYearApiFp = function(configuration?: Configuration) {
280
280
  * @param {*} [options] Override http request option.
281
281
  * @throws {RequiredError}
282
282
  */
283
- async deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
284
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete(metricId, frameworkId, year, options);
283
+ async deleteMetricCost(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
284
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMetricCost(metricId, frameworkId, year, options);
285
285
  const index = configuration?.serverIndex ?? 0;
286
- const operationBasePath = operationServerMap['MetricCostsPerYearApi.deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete']?.[index]?.url;
286
+ const operationBasePath = operationServerMap['MetricCostsPerYearApi.deleteMetricCost']?.[index]?.url;
287
287
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
288
288
  },
289
289
  /**
@@ -295,10 +295,10 @@ export const MetricCostsPerYearApiFp = function(configuration?: Configuration) {
295
295
  * @param {*} [options] Override http request option.
296
296
  * @throws {RequiredError}
297
297
  */
298
- async getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
299
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet(metricId, frameworkId, year, options);
298
+ async getMetricCostByKeys(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
299
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostByKeys(metricId, frameworkId, year, options);
300
300
  const index = configuration?.serverIndex ?? 0;
301
- const operationBasePath = operationServerMap['MetricCostsPerYearApi.getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet']?.[index]?.url;
301
+ const operationBasePath = operationServerMap['MetricCostsPerYearApi.getMetricCostByKeys']?.[index]?.url;
302
302
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
303
303
  },
304
304
  /**
@@ -309,10 +309,10 @@ export const MetricCostsPerYearApiFp = function(configuration?: Configuration) {
309
309
  * @param {*} [options] Override http request option.
310
310
  * @throws {RequiredError}
311
311
  */
312
- async getMetricCostsMetricCostsPerYearGet(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
313
- const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCostsMetricCostsPerYearGet(offset, limit, options);
312
+ async getMetricCosts(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetricCostsPerYearResponse>>> {
313
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getMetricCosts(offset, limit, options);
314
314
  const index = configuration?.serverIndex ?? 0;
315
- const operationBasePath = operationServerMap['MetricCostsPerYearApi.getMetricCostsMetricCostsPerYearGet']?.[index]?.url;
315
+ const operationBasePath = operationServerMap['MetricCostsPerYearApi.getMetricCosts']?.[index]?.url;
316
316
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
317
317
  },
318
318
  /**
@@ -325,10 +325,10 @@ export const MetricCostsPerYearApiFp = function(configuration?: Configuration) {
325
325
  * @param {*} [options] Override http request option.
326
326
  * @throws {RequiredError}
327
327
  */
328
- async patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch(metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
329
- const localVarAxiosArgs = await localVarAxiosParamCreator.patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch(metricId, frameworkId, year, metricCostsPerYearUpdate, options);
328
+ async patchMetricCost(metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
329
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options);
330
330
  const index = configuration?.serverIndex ?? 0;
331
- const operationBasePath = operationServerMap['MetricCostsPerYearApi.patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch']?.[index]?.url;
331
+ const operationBasePath = operationServerMap['MetricCostsPerYearApi.patchMetricCost']?.[index]?.url;
332
332
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
333
333
  },
334
334
  /**
@@ -338,10 +338,10 @@ export const MetricCostsPerYearApiFp = function(configuration?: Configuration) {
338
338
  * @param {*} [options] Override http request option.
339
339
  * @throws {RequiredError}
340
340
  */
341
- async postMetricCostMetricCostsPerYearPost(metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
342
- const localVarAxiosArgs = await localVarAxiosParamCreator.postMetricCostMetricCostsPerYearPost(metricCostsPerYearCreate, options);
341
+ async postMetricCost(metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetricCostsPerYearResponse>> {
342
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postMetricCost(metricCostsPerYearCreate, options);
343
343
  const index = configuration?.serverIndex ?? 0;
344
- const operationBasePath = operationServerMap['MetricCostsPerYearApi.postMetricCostMetricCostsPerYearPost']?.[index]?.url;
344
+ const operationBasePath = operationServerMap['MetricCostsPerYearApi.postMetricCost']?.[index]?.url;
345
345
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
346
346
  },
347
347
  }
@@ -357,182 +357,64 @@ export const MetricCostsPerYearApiFactory = function (configuration?: Configurat
357
357
  /**
358
358
  * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
359
359
  * @summary Delete metric costs for a year
360
- * @param {MetricCostsPerYearApiDeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRequest} requestParameters Request parameters.
360
+ * @param {string} metricId UUID of the metric
361
+ * @param {string} frameworkId UUID of the value framework
362
+ * @param {number} year Year (1600-3000)
361
363
  * @param {*} [options] Override http request option.
362
364
  * @throws {RequiredError}
363
365
  */
364
- deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete(requestParameters: MetricCostsPerYearApiDeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
365
- return localVarFp.deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete(requestParameters.metricId, requestParameters.frameworkId, requestParameters.year, options).then((request) => request(axios, basePath));
366
+ deleteMetricCost(metricId: string, frameworkId: string, year: number, options?: any): AxiosPromise<void> {
367
+ return localVarFp.deleteMetricCost(metricId, frameworkId, year, options).then((request) => request(axios, basePath));
366
368
  },
367
369
  /**
368
370
  * Retrieve cost data for a specific metric within a framework for a given year.
369
371
  * @summary Get a yearly metric cost by metric, framework, and year
370
- * @param {MetricCostsPerYearApiGetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRequest} requestParameters Request parameters.
372
+ * @param {string} metricId UUID of the metric
373
+ * @param {string} frameworkId UUID of the value framework
374
+ * @param {number} year Year (1600-3000)
371
375
  * @param {*} [options] Override http request option.
372
376
  * @throws {RequiredError}
373
377
  */
374
- getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet(requestParameters: MetricCostsPerYearApiGetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
375
- return localVarFp.getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet(requestParameters.metricId, requestParameters.frameworkId, requestParameters.year, options).then((request) => request(axios, basePath));
378
+ getMetricCostByKeys(metricId: string, frameworkId: string, year: number, options?: any): AxiosPromise<MetricCostsPerYearResponse> {
379
+ return localVarFp.getMetricCostByKeys(metricId, frameworkId, year, options).then((request) => request(axios, basePath));
376
380
  },
377
381
  /**
378
382
  * Retrieve a paginated list of all yearly metric cost overrides.
379
383
  * @summary List yearly metric costs
380
- * @param {MetricCostsPerYearApiGetMetricCostsMetricCostsPerYearGetRequest} requestParameters Request parameters.
384
+ * @param {number} [offset] Number of records to skip
385
+ * @param {number} [limit] Max number of records to return
381
386
  * @param {*} [options] Override http request option.
382
387
  * @throws {RequiredError}
383
388
  */
384
- getMetricCostsMetricCostsPerYearGet(requestParameters: MetricCostsPerYearApiGetMetricCostsMetricCostsPerYearGetRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<Array<MetricCostsPerYearResponse>> {
385
- return localVarFp.getMetricCostsMetricCostsPerYearGet(requestParameters.offset, requestParameters.limit, options).then((request) => request(axios, basePath));
389
+ getMetricCosts(offset?: number, limit?: number, options?: any): AxiosPromise<Array<MetricCostsPerYearResponse>> {
390
+ return localVarFp.getMetricCosts(offset, limit, options).then((request) => request(axios, basePath));
386
391
  },
387
392
  /**
388
393
  * Update the perceived and/or direct cost of a metric for a specific year and framework. Identified by the composite key (metric_id, framework_id, year).
389
394
  * @summary Partially update metric costs for a year
390
- * @param {MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRequest} requestParameters Request parameters.
395
+ * @param {string} metricId UUID of the metric
396
+ * @param {string} frameworkId UUID of the value framework
397
+ * @param {number} year Year (1600-3000)
398
+ * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
391
399
  * @param {*} [options] Override http request option.
392
400
  * @throws {RequiredError}
393
401
  */
394
- patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch(requestParameters: MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
395
- return localVarFp.patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch(requestParameters.metricId, requestParameters.frameworkId, requestParameters.year, requestParameters.metricCostsPerYearUpdate, options).then((request) => request(axios, basePath));
402
+ patchMetricCost(metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: any): AxiosPromise<MetricCostsPerYearResponse> {
403
+ return localVarFp.patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options).then((request) => request(axios, basePath));
396
404
  },
397
405
  /**
398
406
  * Create a yearly cost override for a metric within a framework. Year must be between 1600 and 3000, costs must be >= 0.
399
407
  * @summary Create a yearly metric cost
400
- * @param {MetricCostsPerYearApiPostMetricCostMetricCostsPerYearPostRequest} requestParameters Request parameters.
408
+ * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
401
409
  * @param {*} [options] Override http request option.
402
410
  * @throws {RequiredError}
403
411
  */
404
- postMetricCostMetricCostsPerYearPost(requestParameters: MetricCostsPerYearApiPostMetricCostMetricCostsPerYearPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<MetricCostsPerYearResponse> {
405
- return localVarFp.postMetricCostMetricCostsPerYearPost(requestParameters.metricCostsPerYearCreate, options).then((request) => request(axios, basePath));
412
+ postMetricCost(metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: any): AxiosPromise<MetricCostsPerYearResponse> {
413
+ return localVarFp.postMetricCost(metricCostsPerYearCreate, options).then((request) => request(axios, basePath));
406
414
  },
407
415
  };
408
416
  };
409
417
 
410
- /**
411
- * Request parameters for deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete operation in MetricCostsPerYearApi.
412
- * @export
413
- * @interface MetricCostsPerYearApiDeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRequest
414
- */
415
- export interface MetricCostsPerYearApiDeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRequest {
416
- /**
417
- * UUID of the metric
418
- * @type {string}
419
- * @memberof MetricCostsPerYearApiDeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete
420
- */
421
- readonly metricId: string
422
-
423
- /**
424
- * UUID of the value framework
425
- * @type {string}
426
- * @memberof MetricCostsPerYearApiDeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete
427
- */
428
- readonly frameworkId: string
429
-
430
- /**
431
- * Year (1600-3000)
432
- * @type {number}
433
- * @memberof MetricCostsPerYearApiDeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete
434
- */
435
- readonly year: number
436
- }
437
-
438
- /**
439
- * Request parameters for getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet operation in MetricCostsPerYearApi.
440
- * @export
441
- * @interface MetricCostsPerYearApiGetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRequest
442
- */
443
- export interface MetricCostsPerYearApiGetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRequest {
444
- /**
445
- * UUID of the metric
446
- * @type {string}
447
- * @memberof MetricCostsPerYearApiGetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet
448
- */
449
- readonly metricId: string
450
-
451
- /**
452
- * UUID of the value framework
453
- * @type {string}
454
- * @memberof MetricCostsPerYearApiGetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet
455
- */
456
- readonly frameworkId: string
457
-
458
- /**
459
- * Year (1600-3000)
460
- * @type {number}
461
- * @memberof MetricCostsPerYearApiGetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet
462
- */
463
- readonly year: number
464
- }
465
-
466
- /**
467
- * Request parameters for getMetricCostsMetricCostsPerYearGet operation in MetricCostsPerYearApi.
468
- * @export
469
- * @interface MetricCostsPerYearApiGetMetricCostsMetricCostsPerYearGetRequest
470
- */
471
- export interface MetricCostsPerYearApiGetMetricCostsMetricCostsPerYearGetRequest {
472
- /**
473
- * Number of records to skip
474
- * @type {number}
475
- * @memberof MetricCostsPerYearApiGetMetricCostsMetricCostsPerYearGet
476
- */
477
- readonly offset?: number
478
-
479
- /**
480
- * Max number of records to return
481
- * @type {number}
482
- * @memberof MetricCostsPerYearApiGetMetricCostsMetricCostsPerYearGet
483
- */
484
- readonly limit?: number
485
- }
486
-
487
- /**
488
- * Request parameters for patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch operation in MetricCostsPerYearApi.
489
- * @export
490
- * @interface MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRequest
491
- */
492
- export interface MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRequest {
493
- /**
494
- * UUID of the metric
495
- * @type {string}
496
- * @memberof MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch
497
- */
498
- readonly metricId: string
499
-
500
- /**
501
- * UUID of the value framework
502
- * @type {string}
503
- * @memberof MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch
504
- */
505
- readonly frameworkId: string
506
-
507
- /**
508
- * Year (1600-3000)
509
- * @type {number}
510
- * @memberof MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch
511
- */
512
- readonly year: number
513
-
514
- /**
515
- *
516
- * @type {MetricCostsPerYearUpdate}
517
- * @memberof MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch
518
- */
519
- readonly metricCostsPerYearUpdate: MetricCostsPerYearUpdate
520
- }
521
-
522
- /**
523
- * Request parameters for postMetricCostMetricCostsPerYearPost operation in MetricCostsPerYearApi.
524
- * @export
525
- * @interface MetricCostsPerYearApiPostMetricCostMetricCostsPerYearPostRequest
526
- */
527
- export interface MetricCostsPerYearApiPostMetricCostMetricCostsPerYearPostRequest {
528
- /**
529
- *
530
- * @type {MetricCostsPerYearCreate}
531
- * @memberof MetricCostsPerYearApiPostMetricCostMetricCostsPerYearPost
532
- */
533
- readonly metricCostsPerYearCreate: MetricCostsPerYearCreate
534
- }
535
-
536
418
  /**
537
419
  * MetricCostsPerYearApi - object-oriented interface
538
420
  * @export
@@ -543,61 +425,69 @@ export class MetricCostsPerYearApi extends BaseAPI {
543
425
  /**
544
426
  * Delete a metric cost entry by its composite key (metric_id, framework_id, year).
545
427
  * @summary Delete metric costs for a year
546
- * @param {MetricCostsPerYearApiDeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRequest} requestParameters Request parameters.
428
+ * @param {string} metricId UUID of the metric
429
+ * @param {string} frameworkId UUID of the value framework
430
+ * @param {number} year Year (1600-3000)
547
431
  * @param {*} [options] Override http request option.
548
432
  * @throws {RequiredError}
549
433
  * @memberof MetricCostsPerYearApi
550
434
  */
551
- public deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete(requestParameters: MetricCostsPerYearApiDeleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDeleteRequest, options?: RawAxiosRequestConfig) {
552
- return MetricCostsPerYearApiFp(this.configuration).deleteMetricCostMetricCostsPerYearMetricIdFrameworkIdYearDelete(requestParameters.metricId, requestParameters.frameworkId, requestParameters.year, options).then((request) => request(this.axios, this.basePath));
435
+ public deleteMetricCost(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig) {
436
+ return MetricCostsPerYearApiFp(this.configuration).deleteMetricCost(metricId, frameworkId, year, options).then((request) => request(this.axios, this.basePath));
553
437
  }
554
438
 
555
439
  /**
556
440
  * Retrieve cost data for a specific metric within a framework for a given year.
557
441
  * @summary Get a yearly metric cost by metric, framework, and year
558
- * @param {MetricCostsPerYearApiGetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRequest} requestParameters Request parameters.
442
+ * @param {string} metricId UUID of the metric
443
+ * @param {string} frameworkId UUID of the value framework
444
+ * @param {number} year Year (1600-3000)
559
445
  * @param {*} [options] Override http request option.
560
446
  * @throws {RequiredError}
561
447
  * @memberof MetricCostsPerYearApi
562
448
  */
563
- public getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet(requestParameters: MetricCostsPerYearApiGetMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGetRequest, options?: RawAxiosRequestConfig) {
564
- return MetricCostsPerYearApiFp(this.configuration).getMetricCostByKeysMetricCostsPerYearMetricIdFrameworkIdYearGet(requestParameters.metricId, requestParameters.frameworkId, requestParameters.year, options).then((request) => request(this.axios, this.basePath));
449
+ public getMetricCostByKeys(metricId: string, frameworkId: string, year: number, options?: RawAxiosRequestConfig) {
450
+ return MetricCostsPerYearApiFp(this.configuration).getMetricCostByKeys(metricId, frameworkId, year, options).then((request) => request(this.axios, this.basePath));
565
451
  }
566
452
 
567
453
  /**
568
454
  * Retrieve a paginated list of all yearly metric cost overrides.
569
455
  * @summary List yearly metric costs
570
- * @param {MetricCostsPerYearApiGetMetricCostsMetricCostsPerYearGetRequest} requestParameters Request parameters.
456
+ * @param {number} [offset] Number of records to skip
457
+ * @param {number} [limit] Max number of records to return
571
458
  * @param {*} [options] Override http request option.
572
459
  * @throws {RequiredError}
573
460
  * @memberof MetricCostsPerYearApi
574
461
  */
575
- public getMetricCostsMetricCostsPerYearGet(requestParameters: MetricCostsPerYearApiGetMetricCostsMetricCostsPerYearGetRequest = {}, options?: RawAxiosRequestConfig) {
576
- return MetricCostsPerYearApiFp(this.configuration).getMetricCostsMetricCostsPerYearGet(requestParameters.offset, requestParameters.limit, options).then((request) => request(this.axios, this.basePath));
462
+ public getMetricCosts(offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
463
+ return MetricCostsPerYearApiFp(this.configuration).getMetricCosts(offset, limit, options).then((request) => request(this.axios, this.basePath));
577
464
  }
578
465
 
579
466
  /**
580
467
  * Update the perceived and/or direct cost of a metric for a specific year and framework. Identified by the composite key (metric_id, framework_id, year).
581
468
  * @summary Partially update metric costs for a year
582
- * @param {MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRequest} requestParameters Request parameters.
469
+ * @param {string} metricId UUID of the metric
470
+ * @param {string} frameworkId UUID of the value framework
471
+ * @param {number} year Year (1600-3000)
472
+ * @param {MetricCostsPerYearUpdate} metricCostsPerYearUpdate
583
473
  * @param {*} [options] Override http request option.
584
474
  * @throws {RequiredError}
585
475
  * @memberof MetricCostsPerYearApi
586
476
  */
587
- public patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch(requestParameters: MetricCostsPerYearApiPatchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatchRequest, options?: RawAxiosRequestConfig) {
588
- return MetricCostsPerYearApiFp(this.configuration).patchMetricCostMetricCostsPerYearMetricIdFrameworkIdYearPatch(requestParameters.metricId, requestParameters.frameworkId, requestParameters.year, requestParameters.metricCostsPerYearUpdate, options).then((request) => request(this.axios, this.basePath));
477
+ public patchMetricCost(metricId: string, frameworkId: string, year: number, metricCostsPerYearUpdate: MetricCostsPerYearUpdate, options?: RawAxiosRequestConfig) {
478
+ return MetricCostsPerYearApiFp(this.configuration).patchMetricCost(metricId, frameworkId, year, metricCostsPerYearUpdate, options).then((request) => request(this.axios, this.basePath));
589
479
  }
590
480
 
591
481
  /**
592
482
  * Create a yearly cost override for a metric within a framework. Year must be between 1600 and 3000, costs must be >= 0.
593
483
  * @summary Create a yearly metric cost
594
- * @param {MetricCostsPerYearApiPostMetricCostMetricCostsPerYearPostRequest} requestParameters Request parameters.
484
+ * @param {MetricCostsPerYearCreate} metricCostsPerYearCreate
595
485
  * @param {*} [options] Override http request option.
596
486
  * @throws {RequiredError}
597
487
  * @memberof MetricCostsPerYearApi
598
488
  */
599
- public postMetricCostMetricCostsPerYearPost(requestParameters: MetricCostsPerYearApiPostMetricCostMetricCostsPerYearPostRequest, options?: RawAxiosRequestConfig) {
600
- return MetricCostsPerYearApiFp(this.configuration).postMetricCostMetricCostsPerYearPost(requestParameters.metricCostsPerYearCreate, options).then((request) => request(this.axios, this.basePath));
489
+ public postMetricCost(metricCostsPerYearCreate: MetricCostsPerYearCreate, options?: RawAxiosRequestConfig) {
490
+ return MetricCostsPerYearApiFp(this.configuration).postMetricCost(metricCostsPerYearCreate, options).then((request) => request(this.axios, this.basePath));
601
491
  }
602
492
  }
603
493