@epilot/metering-client 0.2.3 → 0.2.5
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/CHANGELOG.md +5 -0
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +342 -220
- package/package.json +1 -1
- package/src/openapi.d.ts +0 -945
package/dist/openapi.d.ts
CHANGED
|
@@ -8,80 +8,96 @@ import type {
|
|
|
8
8
|
} from 'openapi-client-axios';
|
|
9
9
|
|
|
10
10
|
declare namespace Components {
|
|
11
|
+
namespace Responses {
|
|
12
|
+
export type Forbidden = Schemas.ErrorResp;
|
|
13
|
+
export type InternalServerError = Schemas.ErrorResp;
|
|
14
|
+
export type InvalidRequest = Schemas.ErrorResp;
|
|
15
|
+
export type NotFound = Schemas.ErrorResp;
|
|
16
|
+
export type Unauthorized = Schemas.ErrorResp;
|
|
17
|
+
}
|
|
11
18
|
namespace Schemas {
|
|
12
|
-
/**
|
|
13
|
-
* example:
|
|
14
|
-
* {
|
|
15
|
-
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
16
|
-
* "_org": "123",
|
|
17
|
-
* "_schema": "contact",
|
|
18
|
-
* "_tags": [
|
|
19
|
-
* "example",
|
|
20
|
-
* "mock"
|
|
21
|
-
* ],
|
|
22
|
-
* "_created_at": "2021-02-09T12:41:43.662Z",
|
|
23
|
-
* "_updated_at": "2021-02-09T12:41:43.662Z"
|
|
24
|
-
* }
|
|
25
|
-
*/
|
|
26
19
|
export interface BaseEntity {
|
|
20
|
+
/**
|
|
21
|
+
* Entity ID
|
|
22
|
+
* example:
|
|
23
|
+
* 3fa85f64-5717-4562-b3fc-2c963f66afa6
|
|
24
|
+
*/
|
|
27
25
|
_id: EntityId;
|
|
28
26
|
/**
|
|
29
|
-
* Title of entity
|
|
27
|
+
* Title of the entity
|
|
28
|
+
* example:
|
|
29
|
+
* Example Entity
|
|
30
30
|
*/
|
|
31
31
|
_title: string;
|
|
32
32
|
/**
|
|
33
|
-
* Organization
|
|
33
|
+
* Organization ID the entity belongs to
|
|
34
|
+
* example:
|
|
35
|
+
* 123
|
|
34
36
|
*/
|
|
35
37
|
_org: string;
|
|
36
|
-
|
|
37
|
-
*
|
|
38
|
+
/**
|
|
39
|
+
* Array of entity tags
|
|
38
40
|
* example:
|
|
39
|
-
*
|
|
41
|
+
* [
|
|
42
|
+
* "example",
|
|
43
|
+
* "mock"
|
|
44
|
+
* ]
|
|
40
45
|
*/
|
|
41
|
-
EntitySlug;
|
|
42
46
|
_tags?: string[];
|
|
43
|
-
|
|
44
|
-
|
|
47
|
+
/**
|
|
48
|
+
* Creation timestamp of the entity
|
|
49
|
+
* example:
|
|
50
|
+
* 2021-02-09T12:41:43.662Z
|
|
51
|
+
*/
|
|
52
|
+
_created_at: string; // date-time
|
|
53
|
+
/**
|
|
54
|
+
* Last update timestamp of the entity
|
|
55
|
+
* example:
|
|
56
|
+
* 2021-02-09T12:41:43.662Z
|
|
57
|
+
*/
|
|
58
|
+
_updated_at: string; // date-time
|
|
45
59
|
}
|
|
46
60
|
export type Direction = "feed-in" | "feed-out";
|
|
47
61
|
export interface Entity {
|
|
48
62
|
[name: string]: any;
|
|
49
63
|
}
|
|
50
64
|
export type EntityId = string;
|
|
51
|
-
/**
|
|
52
|
-
* example:
|
|
53
|
-
* {
|
|
54
|
-
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
55
|
-
* "_org": "123",
|
|
56
|
-
* "_schema": "contact",
|
|
57
|
-
* "_tags": [
|
|
58
|
-
* "example",
|
|
59
|
-
* "mock"
|
|
60
|
-
* ],
|
|
61
|
-
* "_created_at": {},
|
|
62
|
-
* "_updated_at": {}
|
|
63
|
-
* }
|
|
64
|
-
*/
|
|
65
65
|
export interface EntityItem {
|
|
66
66
|
[name: string]: any;
|
|
67
67
|
_id: EntityId;
|
|
68
68
|
/**
|
|
69
|
-
* Title of entity
|
|
69
|
+
* Title of the entity
|
|
70
|
+
* example:
|
|
71
|
+
* Example Entity
|
|
70
72
|
*/
|
|
71
73
|
_title: string;
|
|
72
74
|
/**
|
|
73
|
-
* Organization
|
|
75
|
+
* Organization ID the entity belongs to
|
|
76
|
+
* example:
|
|
77
|
+
* 123
|
|
74
78
|
*/
|
|
75
79
|
_org: string;
|
|
76
|
-
|
|
77
|
-
*
|
|
80
|
+
/**
|
|
81
|
+
* Array of entity tags
|
|
78
82
|
* example:
|
|
79
|
-
*
|
|
83
|
+
* [
|
|
84
|
+
* "example",
|
|
85
|
+
* "mock"
|
|
86
|
+
* ]
|
|
80
87
|
*/
|
|
81
|
-
EntitySlug;
|
|
82
88
|
_tags?: string[];
|
|
83
|
-
|
|
84
|
-
|
|
89
|
+
/**
|
|
90
|
+
* Creation timestamp of the entity
|
|
91
|
+
* example:
|
|
92
|
+
* 2021-02-09T12:41:43.662Z
|
|
93
|
+
*/
|
|
94
|
+
_created_at: string; // date-time
|
|
95
|
+
/**
|
|
96
|
+
* Last update timestamp of the entity
|
|
97
|
+
* example:
|
|
98
|
+
* 2021-02-09T12:41:43.662Z
|
|
99
|
+
*/
|
|
100
|
+
_updated_at: string; // date-time
|
|
85
101
|
}
|
|
86
102
|
export interface EntityRelation {
|
|
87
103
|
/**
|
|
@@ -97,58 +113,80 @@ declare namespace Components {
|
|
|
97
113
|
* contact
|
|
98
114
|
*/
|
|
99
115
|
export type EntitySlug = string;
|
|
116
|
+
export interface ErrorResp {
|
|
117
|
+
/**
|
|
118
|
+
* Error message
|
|
119
|
+
*/
|
|
120
|
+
message?: string;
|
|
121
|
+
}
|
|
100
122
|
export type Id = string;
|
|
101
|
-
/**
|
|
102
|
-
* example:
|
|
103
|
-
* {
|
|
104
|
-
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
105
|
-
* "_org": "123",
|
|
106
|
-
* "_schema": "contact",
|
|
107
|
-
* "_tags": [
|
|
108
|
-
* "example",
|
|
109
|
-
* "mock"
|
|
110
|
-
* ],
|
|
111
|
-
* "_created_at": {},
|
|
112
|
-
* "_updated_at": {}
|
|
113
|
-
* }
|
|
114
|
-
*/
|
|
115
123
|
export interface Meter {
|
|
116
124
|
_id: EntityId;
|
|
117
125
|
/**
|
|
118
|
-
* Title of entity
|
|
126
|
+
* Title of the entity
|
|
127
|
+
* example:
|
|
128
|
+
* Example Entity
|
|
119
129
|
*/
|
|
120
130
|
_title: string;
|
|
121
131
|
/**
|
|
122
|
-
* Organization
|
|
132
|
+
* Organization ID the entity belongs to
|
|
133
|
+
* example:
|
|
134
|
+
* 123
|
|
123
135
|
*/
|
|
124
136
|
_org: string;
|
|
125
|
-
|
|
126
|
-
*
|
|
137
|
+
/**
|
|
138
|
+
* Array of entity tags
|
|
127
139
|
* example:
|
|
128
|
-
*
|
|
140
|
+
* [
|
|
141
|
+
* "example",
|
|
142
|
+
* "mock"
|
|
143
|
+
* ]
|
|
129
144
|
*/
|
|
130
|
-
EntitySlug;
|
|
131
145
|
_tags?: string[];
|
|
132
|
-
_created_at: string;
|
|
133
|
-
_updated_at: string;
|
|
134
146
|
/**
|
|
147
|
+
* Creation timestamp of the entity
|
|
148
|
+
* example:
|
|
149
|
+
* 2021-02-09T12:41:43.662Z
|
|
150
|
+
*/
|
|
151
|
+
_created_at: string; // date-time
|
|
152
|
+
/**
|
|
153
|
+
* Last update timestamp of the entity
|
|
154
|
+
* example:
|
|
155
|
+
* 2021-02-09T12:41:43.662Z
|
|
156
|
+
*/
|
|
157
|
+
_updated_at: string; // date-time
|
|
158
|
+
/**
|
|
159
|
+
* The schema type of the meter
|
|
160
|
+
*/
|
|
161
|
+
_schema: "meter";
|
|
162
|
+
/**
|
|
163
|
+
* The MA-LO ID of the meter
|
|
135
164
|
* example:
|
|
136
165
|
* A09-123
|
|
137
166
|
*/
|
|
138
167
|
ma_lo_id?: string;
|
|
168
|
+
/**
|
|
169
|
+
* The type of the meter
|
|
170
|
+
*/
|
|
139
171
|
meter_type?: "three-phase-meter" | "bellow-gas-meter" | "rotary-piston-meter" | "smart-meter" | "performance-meter" | "maximum-meter" | "turbine-gas-meter" | "ultrasonic-gas-meter" | "alternating-current-meter" | "modern-metering-system" | "intelligent-measuring-system" | "electronic-meter";
|
|
140
172
|
/**
|
|
173
|
+
* The tariff type of the meter
|
|
141
174
|
* example:
|
|
142
175
|
* Peak load tariff
|
|
143
176
|
*/
|
|
144
177
|
tariff_type?: string;
|
|
145
178
|
/**
|
|
179
|
+
* The number of the meter
|
|
146
180
|
* example:
|
|
147
181
|
* J-1093-1AK
|
|
148
182
|
*/
|
|
149
183
|
meter_number?: string;
|
|
184
|
+
/**
|
|
185
|
+
* The sector to which the meter belongs
|
|
186
|
+
*/
|
|
150
187
|
sector?: "power" | "water" | "gas";
|
|
151
188
|
/**
|
|
189
|
+
* The location information of the meter
|
|
152
190
|
* example:
|
|
153
191
|
* [
|
|
154
192
|
* {
|
|
@@ -169,93 +207,112 @@ declare namespace Components {
|
|
|
169
207
|
[key: string]: any;
|
|
170
208
|
};
|
|
171
209
|
/**
|
|
210
|
+
* The usage purpose of the meter
|
|
172
211
|
* example:
|
|
173
212
|
* Domestic Usage
|
|
174
213
|
*/
|
|
175
214
|
used_for?: string;
|
|
176
215
|
/**
|
|
216
|
+
* The manufacturer of the meter
|
|
177
217
|
* example:
|
|
178
218
|
* Energy One
|
|
179
219
|
*/
|
|
180
220
|
manufacturer?: string;
|
|
181
221
|
/**
|
|
222
|
+
* The calibration date of the meter
|
|
182
223
|
* example:
|
|
183
224
|
* {}
|
|
184
225
|
*/
|
|
185
226
|
calibration_date?: string;
|
|
227
|
+
/**
|
|
228
|
+
* The contract associated with the meter
|
|
229
|
+
*/
|
|
186
230
|
contract?: {
|
|
187
231
|
$relation?: EntityRelation[];
|
|
188
232
|
};
|
|
233
|
+
/**
|
|
234
|
+
* The customer associated with the meter
|
|
235
|
+
*/
|
|
189
236
|
customer?: {
|
|
190
237
|
$relation?: EntityRelation[];
|
|
191
238
|
};
|
|
192
239
|
}
|
|
193
|
-
/**
|
|
194
|
-
* example:
|
|
195
|
-
* {
|
|
196
|
-
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
197
|
-
* "_org": "123",
|
|
198
|
-
* "_schema": "contact",
|
|
199
|
-
* "_tags": [
|
|
200
|
-
* "example",
|
|
201
|
-
* "mock"
|
|
202
|
-
* ],
|
|
203
|
-
* "_created_at": {},
|
|
204
|
-
* "_updated_at": {}
|
|
205
|
-
* }
|
|
206
|
-
*/
|
|
207
240
|
export interface MeterCounter {
|
|
208
241
|
_id: EntityId;
|
|
209
242
|
/**
|
|
210
|
-
* Title of entity
|
|
243
|
+
* Title of the entity
|
|
244
|
+
* example:
|
|
245
|
+
* Example Entity
|
|
211
246
|
*/
|
|
212
247
|
_title: string;
|
|
213
248
|
/**
|
|
214
|
-
* Organization
|
|
249
|
+
* Organization ID the entity belongs to
|
|
250
|
+
* example:
|
|
251
|
+
* 123
|
|
215
252
|
*/
|
|
216
253
|
_org: string;
|
|
217
|
-
|
|
218
|
-
*
|
|
254
|
+
/**
|
|
255
|
+
* Array of entity tags
|
|
219
256
|
* example:
|
|
220
|
-
*
|
|
257
|
+
* [
|
|
258
|
+
* "example",
|
|
259
|
+
* "mock"
|
|
260
|
+
* ]
|
|
221
261
|
*/
|
|
222
|
-
EntitySlug;
|
|
223
262
|
_tags?: string[];
|
|
224
|
-
_created_at: string;
|
|
225
|
-
_updated_at: string;
|
|
226
263
|
/**
|
|
264
|
+
* Creation timestamp of the entity
|
|
265
|
+
* example:
|
|
266
|
+
* 2021-02-09T12:41:43.662Z
|
|
267
|
+
*/
|
|
268
|
+
_created_at: string; // date-time
|
|
269
|
+
/**
|
|
270
|
+
* Last update timestamp of the entity
|
|
271
|
+
* example:
|
|
272
|
+
* 2021-02-09T12:41:43.662Z
|
|
273
|
+
*/
|
|
274
|
+
_updated_at: string; // date-time
|
|
275
|
+
_schema: "meter_counter";
|
|
276
|
+
/**
|
|
277
|
+
* The OBIS number of the meter counter
|
|
227
278
|
* example:
|
|
228
279
|
* A-34
|
|
229
280
|
*/
|
|
230
281
|
obis_number?: string;
|
|
231
282
|
direction?: Direction;
|
|
232
283
|
/**
|
|
284
|
+
* The transformer ratio of the meter counter
|
|
233
285
|
* example:
|
|
234
286
|
* 70
|
|
235
287
|
*/
|
|
236
288
|
transformer_ratio?: number;
|
|
237
289
|
unit?: Unit;
|
|
238
290
|
/**
|
|
291
|
+
* The forecast reading value of the meter counter
|
|
239
292
|
* example:
|
|
240
293
|
* 270
|
|
241
294
|
*/
|
|
242
295
|
forecast_reading_value?: string;
|
|
243
296
|
/**
|
|
297
|
+
* The date as of which the forecast reading value is applicable
|
|
244
298
|
* example:
|
|
245
299
|
* {}
|
|
246
300
|
*/
|
|
247
301
|
forecast_as_of?: string;
|
|
248
302
|
/**
|
|
303
|
+
* The current consumption value of the meter counter
|
|
249
304
|
* example:
|
|
250
305
|
* 240
|
|
251
306
|
*/
|
|
252
307
|
current_consumption?: number;
|
|
253
308
|
/**
|
|
309
|
+
* The timestamp of the last reading
|
|
254
310
|
* example:
|
|
255
311
|
* {}
|
|
256
312
|
*/
|
|
257
313
|
last_reading?: string;
|
|
258
314
|
/**
|
|
315
|
+
* The conversion factor for the meter counter
|
|
259
316
|
* example:
|
|
260
317
|
* 3
|
|
261
318
|
*/
|
|
@@ -264,30 +321,38 @@ declare namespace Components {
|
|
|
264
321
|
}
|
|
265
322
|
export interface MeterReading {
|
|
266
323
|
/**
|
|
324
|
+
* The reading value of the meter
|
|
267
325
|
* example:
|
|
268
326
|
* 240
|
|
269
327
|
*/
|
|
270
328
|
value?: number;
|
|
271
329
|
/**
|
|
330
|
+
* The person who recorded the reading
|
|
272
331
|
* example:
|
|
273
332
|
* John Doe
|
|
274
333
|
*/
|
|
275
334
|
read_by?: string;
|
|
276
335
|
/**
|
|
336
|
+
* The reason for recording the reading
|
|
277
337
|
* example:
|
|
278
338
|
* Storing the feed-in record
|
|
279
339
|
*/
|
|
280
340
|
reason?: string;
|
|
281
341
|
/**
|
|
342
|
+
* The ID of the associated meter
|
|
282
343
|
* example:
|
|
283
344
|
* 1446829f-4b6f-474e-b978-3997d89a7928
|
|
284
345
|
*/
|
|
285
346
|
meter_id?: string;
|
|
286
347
|
/**
|
|
348
|
+
* The ID of the associated meter counter
|
|
287
349
|
* example:
|
|
288
350
|
* 991a1821-43bc-46b8-967d-64a3d87c31f8
|
|
289
351
|
*/
|
|
290
352
|
counter_id?: string;
|
|
353
|
+
/**
|
|
354
|
+
* The direction of the reading (feed-in or feed-out)
|
|
355
|
+
*/
|
|
291
356
|
direction?: Direction;
|
|
292
357
|
/**
|
|
293
358
|
* If the value is not provided, the system will be set with the time the request is processed.
|
|
@@ -295,34 +360,54 @@ declare namespace Components {
|
|
|
295
360
|
* "2022-10-10T00:00:00.000Z"
|
|
296
361
|
*/
|
|
297
362
|
timestamp?: string;
|
|
363
|
+
/**
|
|
364
|
+
* The source of the reading
|
|
365
|
+
*/
|
|
298
366
|
source?: Source;
|
|
299
367
|
}
|
|
300
368
|
export interface ReadingWithMeter {
|
|
301
369
|
/**
|
|
370
|
+
* The MA-LO ID of the meter
|
|
302
371
|
* example:
|
|
303
372
|
* A09-123
|
|
304
373
|
*/
|
|
305
374
|
ma_lo_id?: string;
|
|
375
|
+
/**
|
|
376
|
+
* The ID of the associated meter
|
|
377
|
+
*/
|
|
306
378
|
meter_id?: Id;
|
|
307
379
|
/**
|
|
380
|
+
* The OBIS number of the meter counter
|
|
308
381
|
* example:
|
|
309
382
|
* A-34
|
|
310
383
|
*/
|
|
311
384
|
obis_number?: string;
|
|
385
|
+
/**
|
|
386
|
+
* The unit of measurement for the reading
|
|
387
|
+
*/
|
|
312
388
|
unit?: Unit;
|
|
389
|
+
/**
|
|
390
|
+
* The direction of the reading
|
|
391
|
+
*/
|
|
313
392
|
direction?: Direction;
|
|
393
|
+
/**
|
|
394
|
+
* The tariff type of the reading
|
|
395
|
+
*/
|
|
314
396
|
tariff_type?: TariffType;
|
|
315
397
|
/**
|
|
398
|
+
* The reading value
|
|
316
399
|
* example:
|
|
317
400
|
* 240
|
|
318
401
|
*/
|
|
319
402
|
value?: number;
|
|
320
403
|
/**
|
|
404
|
+
* The person who recorded the reading
|
|
321
405
|
* example:
|
|
322
406
|
* John Doe
|
|
323
407
|
*/
|
|
324
408
|
read_by?: string;
|
|
325
409
|
/**
|
|
410
|
+
* The reason for recording the reading
|
|
326
411
|
* example:
|
|
327
412
|
* Storing the feed-in record
|
|
328
413
|
*/
|
|
@@ -333,6 +418,9 @@ declare namespace Components {
|
|
|
333
418
|
* "2022-10-10T10:10:00.000Z"
|
|
334
419
|
*/
|
|
335
420
|
timestamp?: string;
|
|
421
|
+
/**
|
|
422
|
+
* The source of the reading
|
|
423
|
+
*/
|
|
336
424
|
source?: Source;
|
|
337
425
|
}
|
|
338
426
|
export type Source = "ECP" | "ERP" | "360" | "journey-submission";
|
|
@@ -350,14 +438,22 @@ declare namespace Paths {
|
|
|
350
438
|
export interface $200 {
|
|
351
439
|
data?: Components.Schemas.MeterReading;
|
|
352
440
|
}
|
|
441
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
442
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
443
|
+
export type $403 = Components.Responses.Forbidden;
|
|
444
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
353
445
|
}
|
|
354
446
|
}
|
|
355
447
|
namespace CreateMeterReadingFromSubmission {
|
|
356
448
|
export type RequestBody = Components.Schemas.SubmissionMeterReading;
|
|
357
449
|
namespace Responses {
|
|
358
450
|
export interface $200 {
|
|
359
|
-
|
|
451
|
+
message?: "Successfully Processed";
|
|
360
452
|
}
|
|
453
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
454
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
455
|
+
export type $403 = Components.Responses.Forbidden;
|
|
456
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
361
457
|
}
|
|
362
458
|
}
|
|
363
459
|
namespace CreateMeterReadings {
|
|
@@ -368,6 +464,10 @@ declare namespace Paths {
|
|
|
368
464
|
export interface $200 {
|
|
369
465
|
data?: Components.Schemas.MeterReading[];
|
|
370
466
|
}
|
|
467
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
468
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
469
|
+
export type $403 = Components.Responses.Forbidden;
|
|
470
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
371
471
|
}
|
|
372
472
|
}
|
|
373
473
|
namespace CreateReadingWithMeter {
|
|
@@ -376,6 +476,10 @@ declare namespace Paths {
|
|
|
376
476
|
export interface $200 {
|
|
377
477
|
data?: Components.Schemas.MeterReading;
|
|
378
478
|
}
|
|
479
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
480
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
481
|
+
export type $403 = Components.Responses.Forbidden;
|
|
482
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
379
483
|
}
|
|
380
484
|
}
|
|
381
485
|
namespace DeleteMeterReading {
|
|
@@ -384,7 +488,7 @@ declare namespace Paths {
|
|
|
384
488
|
export type MeterId = Components.Schemas.Id;
|
|
385
489
|
/**
|
|
386
490
|
* example:
|
|
387
|
-
*
|
|
491
|
+
* 2022-10-01T20:00:00.000Z
|
|
388
492
|
*/
|
|
389
493
|
export type Timestamp = string;
|
|
390
494
|
}
|
|
@@ -395,7 +499,7 @@ declare namespace Paths {
|
|
|
395
499
|
export interface QueryParameters {
|
|
396
500
|
timestamp: /**
|
|
397
501
|
* example:
|
|
398
|
-
*
|
|
502
|
+
* 2022-10-01T20:00:00.000Z
|
|
399
503
|
*/
|
|
400
504
|
Parameters.Timestamp;
|
|
401
505
|
}
|
|
@@ -406,11 +510,15 @@ declare namespace Paths {
|
|
|
406
510
|
counterId?: Components.Schemas.Id;
|
|
407
511
|
/**
|
|
408
512
|
* example:
|
|
409
|
-
*
|
|
513
|
+
* 2022-10-01T20:00:00.000Z
|
|
410
514
|
*/
|
|
411
515
|
timestamp?: string;
|
|
412
516
|
};
|
|
413
517
|
}
|
|
518
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
519
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
520
|
+
export type $403 = Components.Responses.Forbidden;
|
|
521
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
414
522
|
}
|
|
415
523
|
}
|
|
416
524
|
namespace GetCounterDetails {
|
|
@@ -422,43 +530,23 @@ declare namespace Paths {
|
|
|
422
530
|
}
|
|
423
531
|
namespace Responses {
|
|
424
532
|
export interface $200 {
|
|
425
|
-
data?:
|
|
426
|
-
* example:
|
|
427
|
-
* {
|
|
428
|
-
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
429
|
-
* "_org": "123",
|
|
430
|
-
* "_schema": "contact",
|
|
431
|
-
* "_tags": [
|
|
432
|
-
* "example",
|
|
433
|
-
* "mock"
|
|
434
|
-
* ],
|
|
435
|
-
* "_created_at": {},
|
|
436
|
-
* "_updated_at": {}
|
|
437
|
-
* }
|
|
438
|
-
*/
|
|
439
|
-
Components.Schemas.MeterCounter;
|
|
533
|
+
data?: Components.Schemas.MeterCounter;
|
|
440
534
|
}
|
|
535
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
536
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
537
|
+
export type $403 = Components.Responses.Forbidden;
|
|
538
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
441
539
|
}
|
|
442
540
|
}
|
|
443
541
|
namespace GetCustomerMeters {
|
|
444
542
|
namespace Responses {
|
|
445
543
|
export interface $200 {
|
|
446
|
-
data?:
|
|
447
|
-
* example:
|
|
448
|
-
* {
|
|
449
|
-
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
450
|
-
* "_org": "123",
|
|
451
|
-
* "_schema": "contact",
|
|
452
|
-
* "_tags": [
|
|
453
|
-
* "example",
|
|
454
|
-
* "mock"
|
|
455
|
-
* ],
|
|
456
|
-
* "_created_at": {},
|
|
457
|
-
* "_updated_at": {}
|
|
458
|
-
* }
|
|
459
|
-
*/
|
|
460
|
-
Components.Schemas.Meter[];
|
|
544
|
+
data?: Components.Schemas.Meter[];
|
|
461
545
|
}
|
|
546
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
547
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
548
|
+
export type $403 = Components.Responses.Forbidden;
|
|
549
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
462
550
|
}
|
|
463
551
|
}
|
|
464
552
|
namespace GetDownSampleReadingsByInterval {
|
|
@@ -467,14 +555,14 @@ declare namespace Paths {
|
|
|
467
555
|
export type Direction = Components.Schemas.Direction;
|
|
468
556
|
/**
|
|
469
557
|
* example:
|
|
470
|
-
*
|
|
558
|
+
* 2022-10-10
|
|
471
559
|
*/
|
|
472
560
|
export type EndDate = string;
|
|
473
561
|
export type GroupBy = "day" | "week" | "month" | "year";
|
|
474
562
|
export type MeterId = Components.Schemas.Id;
|
|
475
563
|
/**
|
|
476
564
|
* example:
|
|
477
|
-
*
|
|
565
|
+
* 2022-10-01
|
|
478
566
|
*/
|
|
479
567
|
export type StartDate = string;
|
|
480
568
|
}
|
|
@@ -485,12 +573,12 @@ declare namespace Paths {
|
|
|
485
573
|
export interface QueryParameters {
|
|
486
574
|
start_date?: /**
|
|
487
575
|
* example:
|
|
488
|
-
*
|
|
576
|
+
* 2022-10-01
|
|
489
577
|
*/
|
|
490
578
|
Parameters.StartDate;
|
|
491
579
|
end_date?: /**
|
|
492
580
|
* example:
|
|
493
|
-
*
|
|
581
|
+
* 2022-10-10
|
|
494
582
|
*/
|
|
495
583
|
Parameters.EndDate;
|
|
496
584
|
group_by?: Parameters.GroupBy;
|
|
@@ -500,6 +588,30 @@ declare namespace Paths {
|
|
|
500
588
|
export interface $200 {
|
|
501
589
|
data?: Components.Schemas.MeterReading[];
|
|
502
590
|
}
|
|
591
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
592
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
593
|
+
export type $403 = Components.Responses.Forbidden;
|
|
594
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
595
|
+
}
|
|
596
|
+
}
|
|
597
|
+
namespace GetMeter {
|
|
598
|
+
namespace Parameters {
|
|
599
|
+
export type Id = Components.Schemas.EntityId;
|
|
600
|
+
}
|
|
601
|
+
export interface PathParameters {
|
|
602
|
+
id: Parameters.Id;
|
|
603
|
+
}
|
|
604
|
+
namespace Responses {
|
|
605
|
+
export interface $200 {
|
|
606
|
+
data?: {
|
|
607
|
+
entity?: Components.Schemas.Meter;
|
|
608
|
+
relations?: Components.Schemas.EntityItem[];
|
|
609
|
+
};
|
|
610
|
+
}
|
|
611
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
612
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
613
|
+
export type $403 = Components.Responses.Forbidden;
|
|
614
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
503
615
|
}
|
|
504
616
|
}
|
|
505
617
|
namespace GetMeterCounters {
|
|
@@ -519,22 +631,12 @@ declare namespace Paths {
|
|
|
519
631
|
}
|
|
520
632
|
namespace Responses {
|
|
521
633
|
export interface $200 {
|
|
522
|
-
data?:
|
|
523
|
-
* example:
|
|
524
|
-
* {
|
|
525
|
-
* "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
526
|
-
* "_org": "123",
|
|
527
|
-
* "_schema": "contact",
|
|
528
|
-
* "_tags": [
|
|
529
|
-
* "example",
|
|
530
|
-
* "mock"
|
|
531
|
-
* ],
|
|
532
|
-
* "_created_at": {},
|
|
533
|
-
* "_updated_at": {}
|
|
534
|
-
* }
|
|
535
|
-
*/
|
|
536
|
-
Components.Schemas.MeterCounter[];
|
|
634
|
+
data?: Components.Schemas.MeterCounter[];
|
|
537
635
|
}
|
|
636
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
637
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
638
|
+
export type $403 = Components.Responses.Forbidden;
|
|
639
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
538
640
|
}
|
|
539
641
|
}
|
|
540
642
|
namespace GetReadingsByInterval {
|
|
@@ -543,7 +645,7 @@ declare namespace Paths {
|
|
|
543
645
|
export type Direction = Components.Schemas.Direction;
|
|
544
646
|
/**
|
|
545
647
|
* example:
|
|
546
|
-
*
|
|
648
|
+
* 2022-10-10
|
|
547
649
|
*/
|
|
548
650
|
export type EndDate = string;
|
|
549
651
|
/**
|
|
@@ -559,7 +661,7 @@ declare namespace Paths {
|
|
|
559
661
|
export type Size = number;
|
|
560
662
|
/**
|
|
561
663
|
* example:
|
|
562
|
-
*
|
|
664
|
+
* 2022-10-01
|
|
563
665
|
*/
|
|
564
666
|
export type StartDate = string;
|
|
565
667
|
export type Type = "cumulative" | "relative";
|
|
@@ -571,12 +673,12 @@ declare namespace Paths {
|
|
|
571
673
|
export interface QueryParameters {
|
|
572
674
|
start_date?: /**
|
|
573
675
|
* example:
|
|
574
|
-
*
|
|
676
|
+
* 2022-10-01
|
|
575
677
|
*/
|
|
576
678
|
Parameters.StartDate;
|
|
577
679
|
end_date?: /**
|
|
578
680
|
* example:
|
|
579
|
-
*
|
|
681
|
+
* 2022-10-10
|
|
580
682
|
*/
|
|
581
683
|
Parameters.EndDate;
|
|
582
684
|
direction?: Parameters.Direction;
|
|
@@ -602,10 +704,14 @@ declare namespace Paths {
|
|
|
602
704
|
hits?: number;
|
|
603
705
|
/**
|
|
604
706
|
* example:
|
|
605
|
-
*
|
|
707
|
+
* 2022-10-01T20:00:00.000Z
|
|
606
708
|
*/
|
|
607
709
|
firstRecordCreatedAt?: string;
|
|
608
710
|
}
|
|
711
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
712
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
713
|
+
export type $403 = Components.Responses.Forbidden;
|
|
714
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
609
715
|
}
|
|
610
716
|
}
|
|
611
717
|
namespace UpdateMeter {
|
|
@@ -615,23 +721,15 @@ declare namespace Paths {
|
|
|
615
721
|
export interface PathParameters {
|
|
616
722
|
id: Parameters.Id;
|
|
617
723
|
}
|
|
618
|
-
export type RequestBody = Components.Schemas.
|
|
724
|
+
export type RequestBody = Components.Schemas.Meter;
|
|
619
725
|
namespace Responses {
|
|
620
|
-
export
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
* "example",
|
|
628
|
-
* "mock"
|
|
629
|
-
* ],
|
|
630
|
-
* "_created_at": {},
|
|
631
|
-
* "_updated_at": {}
|
|
632
|
-
* }
|
|
633
|
-
*/
|
|
634
|
-
Components.Schemas.EntityItem;
|
|
726
|
+
export interface $200 {
|
|
727
|
+
data?: Components.Schemas.Meter;
|
|
728
|
+
}
|
|
729
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
730
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
731
|
+
export type $403 = Components.Responses.Forbidden;
|
|
732
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
635
733
|
}
|
|
636
734
|
}
|
|
637
735
|
namespace UpdateMeterReading {
|
|
@@ -640,7 +738,7 @@ declare namespace Paths {
|
|
|
640
738
|
export type MeterId = Components.Schemas.Id;
|
|
641
739
|
/**
|
|
642
740
|
* example:
|
|
643
|
-
*
|
|
741
|
+
* 2022-10-01T20:00:00.000Z
|
|
644
742
|
*/
|
|
645
743
|
export type Timestamp = string;
|
|
646
744
|
}
|
|
@@ -651,7 +749,7 @@ declare namespace Paths {
|
|
|
651
749
|
export interface QueryParameters {
|
|
652
750
|
timestamp: /**
|
|
653
751
|
* example:
|
|
654
|
-
*
|
|
752
|
+
* 2022-10-01T20:00:00.000Z
|
|
655
753
|
*/
|
|
656
754
|
Parameters.Timestamp;
|
|
657
755
|
}
|
|
@@ -660,15 +758,19 @@ declare namespace Paths {
|
|
|
660
758
|
export interface $200 {
|
|
661
759
|
data?: Components.Schemas.MeterReading;
|
|
662
760
|
}
|
|
761
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
762
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
763
|
+
export type $403 = Components.Responses.Forbidden;
|
|
764
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
663
765
|
}
|
|
664
766
|
}
|
|
665
767
|
}
|
|
666
768
|
|
|
667
769
|
export interface OperationMethods {
|
|
668
770
|
/**
|
|
669
|
-
* getCustomerMeters -
|
|
771
|
+
* getCustomerMeters - Get Customer Meters
|
|
670
772
|
*
|
|
671
|
-
*
|
|
773
|
+
* Retrieves all meters related to a customer.
|
|
672
774
|
*/
|
|
673
775
|
'getCustomerMeters'(
|
|
674
776
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -676,9 +778,19 @@ export interface OperationMethods {
|
|
|
676
778
|
config?: AxiosRequestConfig
|
|
677
779
|
): OperationResponse<Paths.GetCustomerMeters.Responses.$200>
|
|
678
780
|
/**
|
|
679
|
-
*
|
|
781
|
+
* getMeter - Get Meter
|
|
680
782
|
*
|
|
681
|
-
*
|
|
783
|
+
* Retrieves the details of a meter.
|
|
784
|
+
*/
|
|
785
|
+
'getMeter'(
|
|
786
|
+
parameters?: Parameters<Paths.GetMeter.PathParameters> | null,
|
|
787
|
+
data?: any,
|
|
788
|
+
config?: AxiosRequestConfig
|
|
789
|
+
): OperationResponse<Paths.GetMeter.Responses.$200>
|
|
790
|
+
/**
|
|
791
|
+
* updateMeter - Update Meter
|
|
792
|
+
*
|
|
793
|
+
* Updates the details of a meter.
|
|
682
794
|
*/
|
|
683
795
|
'updateMeter'(
|
|
684
796
|
parameters?: Parameters<Paths.UpdateMeter.PathParameters> | null,
|
|
@@ -686,9 +798,9 @@ export interface OperationMethods {
|
|
|
686
798
|
config?: AxiosRequestConfig
|
|
687
799
|
): OperationResponse<Paths.UpdateMeter.Responses.$200>
|
|
688
800
|
/**
|
|
689
|
-
* getMeterCounters -
|
|
801
|
+
* getMeterCounters - Get Meter Counters
|
|
690
802
|
*
|
|
691
|
-
*
|
|
803
|
+
* Retrieves all counters for a given meter.
|
|
692
804
|
*/
|
|
693
805
|
'getMeterCounters'(
|
|
694
806
|
parameters?: Parameters<Paths.GetMeterCounters.QueryParameters> | null,
|
|
@@ -696,9 +808,9 @@ export interface OperationMethods {
|
|
|
696
808
|
config?: AxiosRequestConfig
|
|
697
809
|
): OperationResponse<Paths.GetMeterCounters.Responses.$200>
|
|
698
810
|
/**
|
|
699
|
-
* getCounterDetails -
|
|
811
|
+
* getCounterDetails - Get Counter Details
|
|
700
812
|
*
|
|
701
|
-
*
|
|
813
|
+
* Retrieves the details of a meter counter.
|
|
702
814
|
*/
|
|
703
815
|
'getCounterDetails'(
|
|
704
816
|
parameters?: Parameters<Paths.GetCounterDetails.PathParameters> | null,
|
|
@@ -706,9 +818,9 @@ export interface OperationMethods {
|
|
|
706
818
|
config?: AxiosRequestConfig
|
|
707
819
|
): OperationResponse<Paths.GetCounterDetails.Responses.$200>
|
|
708
820
|
/**
|
|
709
|
-
* createMeterReading -
|
|
821
|
+
* createMeterReading - Create Meter Reading
|
|
710
822
|
*
|
|
711
|
-
*
|
|
823
|
+
* Inserts a new meter reading.
|
|
712
824
|
*/
|
|
713
825
|
'createMeterReading'(
|
|
714
826
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -716,9 +828,9 @@ export interface OperationMethods {
|
|
|
716
828
|
config?: AxiosRequestConfig
|
|
717
829
|
): OperationResponse<Paths.CreateMeterReading.Responses.$200>
|
|
718
830
|
/**
|
|
719
|
-
* createMeterReadings -
|
|
831
|
+
* createMeterReadings - Create Meter Readings
|
|
720
832
|
*
|
|
721
|
-
*
|
|
833
|
+
* Inserts multiple meter readings at once.
|
|
722
834
|
*/
|
|
723
835
|
'createMeterReadings'(
|
|
724
836
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -726,9 +838,9 @@ export interface OperationMethods {
|
|
|
726
838
|
config?: AxiosRequestConfig
|
|
727
839
|
): OperationResponse<Paths.CreateMeterReadings.Responses.$200>
|
|
728
840
|
/**
|
|
729
|
-
* createMeterReadingFromSubmission -
|
|
841
|
+
* createMeterReadingFromSubmission - Create Meter Reading from Submission
|
|
730
842
|
*
|
|
731
|
-
*
|
|
843
|
+
* Creates a reading from a journey submission.
|
|
732
844
|
*/
|
|
733
845
|
'createMeterReadingFromSubmission'(
|
|
734
846
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -736,9 +848,9 @@ export interface OperationMethods {
|
|
|
736
848
|
config?: AxiosRequestConfig
|
|
737
849
|
): OperationResponse<Paths.CreateMeterReadingFromSubmission.Responses.$200>
|
|
738
850
|
/**
|
|
739
|
-
* createReadingWithMeter -
|
|
851
|
+
* createReadingWithMeter - Create Reading with Meter
|
|
740
852
|
*
|
|
741
|
-
*
|
|
853
|
+
* Creates a reading along with a meter.
|
|
742
854
|
*/
|
|
743
855
|
'createReadingWithMeter'(
|
|
744
856
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -746,11 +858,11 @@ export interface OperationMethods {
|
|
|
746
858
|
config?: AxiosRequestConfig
|
|
747
859
|
): OperationResponse<Paths.CreateReadingWithMeter.Responses.$200>
|
|
748
860
|
/**
|
|
749
|
-
* getReadingsByInterval -
|
|
861
|
+
* getReadingsByInterval - Get Readings by Interval
|
|
750
862
|
*
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
*
|
|
863
|
+
* Retrieves all readings specified in an interval.
|
|
864
|
+
* If the start_date and end_date are equal, then it returns the readings of the specified date.
|
|
865
|
+
* The start_date should be less than or equal to the end_date.
|
|
754
866
|
*
|
|
755
867
|
*/
|
|
756
868
|
'getReadingsByInterval'(
|
|
@@ -759,9 +871,9 @@ export interface OperationMethods {
|
|
|
759
871
|
config?: AxiosRequestConfig
|
|
760
872
|
): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
|
|
761
873
|
/**
|
|
762
|
-
* updateMeterReading -
|
|
874
|
+
* updateMeterReading - Update Meter Reading
|
|
763
875
|
*
|
|
764
|
-
*
|
|
876
|
+
* Updates a meter reading.
|
|
765
877
|
*/
|
|
766
878
|
'updateMeterReading'(
|
|
767
879
|
parameters?: Parameters<Paths.UpdateMeterReading.PathParameters & Paths.UpdateMeterReading.QueryParameters> | null,
|
|
@@ -769,9 +881,9 @@ export interface OperationMethods {
|
|
|
769
881
|
config?: AxiosRequestConfig
|
|
770
882
|
): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
|
|
771
883
|
/**
|
|
772
|
-
* deleteMeterReading -
|
|
884
|
+
* deleteMeterReading - Delete Meter Reading
|
|
773
885
|
*
|
|
774
|
-
*
|
|
886
|
+
* Deletes a meter reading.
|
|
775
887
|
*/
|
|
776
888
|
'deleteMeterReading'(
|
|
777
889
|
parameters?: Parameters<Paths.DeleteMeterReading.PathParameters & Paths.DeleteMeterReading.QueryParameters> | null,
|
|
@@ -779,11 +891,11 @@ export interface OperationMethods {
|
|
|
779
891
|
config?: AxiosRequestConfig
|
|
780
892
|
): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
|
|
781
893
|
/**
|
|
782
|
-
* getDownSampleReadingsByInterval -
|
|
894
|
+
* getDownSampleReadingsByInterval - Get Down Sample Readings by Interval
|
|
783
895
|
*
|
|
784
|
-
*
|
|
785
|
-
*
|
|
786
|
-
*
|
|
896
|
+
* Retrieves the downsampled data of the entire readings specified in an interval.
|
|
897
|
+
* If the start_date and end_date are equal, then it returns the readings of the specified date.
|
|
898
|
+
* The start_date should be less than or equal to the end_date.
|
|
787
899
|
*
|
|
788
900
|
*/
|
|
789
901
|
'getDownSampleReadingsByInterval'(
|
|
@@ -796,9 +908,9 @@ export interface OperationMethods {
|
|
|
796
908
|
export interface PathsDictionary {
|
|
797
909
|
['/v1/metering/meter']: {
|
|
798
910
|
/**
|
|
799
|
-
* getCustomerMeters -
|
|
911
|
+
* getCustomerMeters - Get Customer Meters
|
|
800
912
|
*
|
|
801
|
-
*
|
|
913
|
+
* Retrieves all meters related to a customer.
|
|
802
914
|
*/
|
|
803
915
|
'get'(
|
|
804
916
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -808,21 +920,31 @@ export interface PathsDictionary {
|
|
|
808
920
|
}
|
|
809
921
|
['/v1/metering/meter/{id}']: {
|
|
810
922
|
/**
|
|
811
|
-
* updateMeter -
|
|
923
|
+
* updateMeter - Update Meter
|
|
812
924
|
*
|
|
813
|
-
*
|
|
925
|
+
* Updates the details of a meter.
|
|
814
926
|
*/
|
|
815
927
|
'patch'(
|
|
816
928
|
parameters?: Parameters<Paths.UpdateMeter.PathParameters> | null,
|
|
817
929
|
data?: Paths.UpdateMeter.RequestBody,
|
|
818
930
|
config?: AxiosRequestConfig
|
|
819
931
|
): OperationResponse<Paths.UpdateMeter.Responses.$200>
|
|
932
|
+
/**
|
|
933
|
+
* getMeter - Get Meter
|
|
934
|
+
*
|
|
935
|
+
* Retrieves the details of a meter.
|
|
936
|
+
*/
|
|
937
|
+
'get'(
|
|
938
|
+
parameters?: Parameters<Paths.GetMeter.PathParameters> | null,
|
|
939
|
+
data?: any,
|
|
940
|
+
config?: AxiosRequestConfig
|
|
941
|
+
): OperationResponse<Paths.GetMeter.Responses.$200>
|
|
820
942
|
}
|
|
821
943
|
['/v1/metering/counter']: {
|
|
822
944
|
/**
|
|
823
|
-
* getMeterCounters -
|
|
945
|
+
* getMeterCounters - Get Meter Counters
|
|
824
946
|
*
|
|
825
|
-
*
|
|
947
|
+
* Retrieves all counters for a given meter.
|
|
826
948
|
*/
|
|
827
949
|
'get'(
|
|
828
950
|
parameters?: Parameters<Paths.GetMeterCounters.QueryParameters> | null,
|
|
@@ -832,9 +954,9 @@ export interface PathsDictionary {
|
|
|
832
954
|
}
|
|
833
955
|
['/v1/metering/counter/{counter_id}']: {
|
|
834
956
|
/**
|
|
835
|
-
* getCounterDetails -
|
|
957
|
+
* getCounterDetails - Get Counter Details
|
|
836
958
|
*
|
|
837
|
-
*
|
|
959
|
+
* Retrieves the details of a meter counter.
|
|
838
960
|
*/
|
|
839
961
|
'get'(
|
|
840
962
|
parameters?: Parameters<Paths.GetCounterDetails.PathParameters> | null,
|
|
@@ -844,9 +966,9 @@ export interface PathsDictionary {
|
|
|
844
966
|
}
|
|
845
967
|
['/v1/metering/reading']: {
|
|
846
968
|
/**
|
|
847
|
-
* createMeterReading -
|
|
969
|
+
* createMeterReading - Create Meter Reading
|
|
848
970
|
*
|
|
849
|
-
*
|
|
971
|
+
* Inserts a new meter reading.
|
|
850
972
|
*/
|
|
851
973
|
'post'(
|
|
852
974
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -856,9 +978,9 @@ export interface PathsDictionary {
|
|
|
856
978
|
}
|
|
857
979
|
['/v1/metering/readings']: {
|
|
858
980
|
/**
|
|
859
|
-
* createMeterReadings -
|
|
981
|
+
* createMeterReadings - Create Meter Readings
|
|
860
982
|
*
|
|
861
|
-
*
|
|
983
|
+
* Inserts multiple meter readings at once.
|
|
862
984
|
*/
|
|
863
985
|
'post'(
|
|
864
986
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -868,9 +990,9 @@ export interface PathsDictionary {
|
|
|
868
990
|
}
|
|
869
991
|
['/v1/metering/reading/submission']: {
|
|
870
992
|
/**
|
|
871
|
-
* createMeterReadingFromSubmission -
|
|
993
|
+
* createMeterReadingFromSubmission - Create Meter Reading from Submission
|
|
872
994
|
*
|
|
873
|
-
*
|
|
995
|
+
* Creates a reading from a journey submission.
|
|
874
996
|
*/
|
|
875
997
|
'post'(
|
|
876
998
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -880,9 +1002,9 @@ export interface PathsDictionary {
|
|
|
880
1002
|
}
|
|
881
1003
|
['/v1/metering/reading/with-meter']: {
|
|
882
1004
|
/**
|
|
883
|
-
* createReadingWithMeter -
|
|
1005
|
+
* createReadingWithMeter - Create Reading with Meter
|
|
884
1006
|
*
|
|
885
|
-
*
|
|
1007
|
+
* Creates a reading along with a meter.
|
|
886
1008
|
*/
|
|
887
1009
|
'post'(
|
|
888
1010
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -892,11 +1014,11 @@ export interface PathsDictionary {
|
|
|
892
1014
|
}
|
|
893
1015
|
['/v1/metering/reading/{meter_id}/{counter_id}']: {
|
|
894
1016
|
/**
|
|
895
|
-
* getReadingsByInterval -
|
|
1017
|
+
* getReadingsByInterval - Get Readings by Interval
|
|
896
1018
|
*
|
|
897
|
-
*
|
|
898
|
-
*
|
|
899
|
-
*
|
|
1019
|
+
* Retrieves all readings specified in an interval.
|
|
1020
|
+
* If the start_date and end_date are equal, then it returns the readings of the specified date.
|
|
1021
|
+
* The start_date should be less than or equal to the end_date.
|
|
900
1022
|
*
|
|
901
1023
|
*/
|
|
902
1024
|
'get'(
|
|
@@ -905,9 +1027,9 @@ export interface PathsDictionary {
|
|
|
905
1027
|
config?: AxiosRequestConfig
|
|
906
1028
|
): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
|
|
907
1029
|
/**
|
|
908
|
-
* updateMeterReading -
|
|
1030
|
+
* updateMeterReading - Update Meter Reading
|
|
909
1031
|
*
|
|
910
|
-
*
|
|
1032
|
+
* Updates a meter reading.
|
|
911
1033
|
*/
|
|
912
1034
|
'put'(
|
|
913
1035
|
parameters?: Parameters<Paths.UpdateMeterReading.PathParameters & Paths.UpdateMeterReading.QueryParameters> | null,
|
|
@@ -915,9 +1037,9 @@ export interface PathsDictionary {
|
|
|
915
1037
|
config?: AxiosRequestConfig
|
|
916
1038
|
): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
|
|
917
1039
|
/**
|
|
918
|
-
* deleteMeterReading -
|
|
1040
|
+
* deleteMeterReading - Delete Meter Reading
|
|
919
1041
|
*
|
|
920
|
-
*
|
|
1042
|
+
* Deletes a meter reading.
|
|
921
1043
|
*/
|
|
922
1044
|
'delete'(
|
|
923
1045
|
parameters?: Parameters<Paths.DeleteMeterReading.PathParameters & Paths.DeleteMeterReading.QueryParameters> | null,
|
|
@@ -927,11 +1049,11 @@ export interface PathsDictionary {
|
|
|
927
1049
|
}
|
|
928
1050
|
['/v1/metering/down-sample/readings/{meter_id}/{counter_id}']: {
|
|
929
1051
|
/**
|
|
930
|
-
* getDownSampleReadingsByInterval -
|
|
1052
|
+
* getDownSampleReadingsByInterval - Get Down Sample Readings by Interval
|
|
931
1053
|
*
|
|
932
|
-
*
|
|
933
|
-
*
|
|
934
|
-
*
|
|
1054
|
+
* Retrieves the downsampled data of the entire readings specified in an interval.
|
|
1055
|
+
* If the start_date and end_date are equal, then it returns the readings of the specified date.
|
|
1056
|
+
* The start_date should be less than or equal to the end_date.
|
|
935
1057
|
*
|
|
936
1058
|
*/
|
|
937
1059
|
'get'(
|