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