@cosmotech/aip-client 0.1.0-rc1 → 0.1.1

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