@epilot/metering-client 0.1.1 → 0.1.3

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.
@@ -1 +1 @@
1
- !function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=n(r(279));t.default=a.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Metering API","version":"1.0.0"},"tags":[{"name":"Epilot_360","description":"Epilot_360"},{"name":"ECP","description":"End customer portal"}],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"paths":{"/v1/metering/reading":{"post":{"operationId":"saveMeterReading","summary":"saveMeterReading","description":"This operation inserts a new meter reading","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"requestBody":{"description":"Meter reading payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeterReading"}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MeterReading"}}}}}}}}},"/v1/metering/reading/{meter_id}/{counter_id}":{"get":{"operationId":"fetchReadingsByInterval","summary":"fetchReadingsByInterval","description":"- Get all readings specified in an interval\\n- If the start_date & end_date are equal, then returns the readings of the specified date\\n- start_date should <= end_date\\n","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"meter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of meter"},{"in":"path","name":"counter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of counter"},{"in":"query","name":"start_date","required":true,"schema":{"type":"string","example":"2022-10-01T00:00:00.000Z"}},{"in":"query","name":"end_date","required":true,"schema":{"type":"string","example":"2022-10-10T00:00:00.000Z"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MeterReading"}},"total_count":{"type":"number","example":120}}}}}}}}},"/v1/metering/down-sample/readings/{meter_id}/{counter_id}":{"get":{"operationId":"fetchDownSampleReadingsByInterval","summary":"fetchDownSampleReadingsByInterval","description":"- Get the down sampled data of the entire readings specified in an interval\\n- If the start_date & end_date are equal, then returns the readings of the specified date\\n- start_date should <= end_date\\n","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"meter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of meter"},{"in":"path","name":"counter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of counter"},{"in":"query","name":"start_date","required":true,"schema":{"type":"string","example":"2022-10-01T00:00:00.000Z"}},{"in":"query","name":"end_date","required":true,"schema":{"type":"string","example":"2022-10-10T00:00:00.000Z"}},{"in":"query","name":"unit","schema":{"type":"string","default":"day","enum":["day","week","month","year"]}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MeterReading"}}}}}}}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"},"CustomerPortalAuth":{"type":"http","scheme":"bearer","description":"Authorization header with customer pilot OAuth2 bearer token","bearerFormat":"JWT"}},"schemas":{"Id":{"type":"string"},"MeterReading":{"type":"object","properties":{"value":{"type":"number","example":240},"unit":{"type":"string","enum":["W","WH","KW","KWH","KVARH","MW","MWH","unit","cubic meter","hour","day","month","year","percentage"]},"read_by":{"type":"string","example":"John Doe"},"reason":{"type":"string","example":"Storing the feed-in record"},"meter_id":{"type":"string","example":"1446829f-4b6f-474e-b978-3997d89a7928"},"counter_id":{"type":"string","example":"2A-3"}}}}}}')}},t={};return function r(n){if(t[n])return t[n].exports;var a=t[n]={exports:{}};return e[n].call(a.exports,a,a.exports,r),a.exports}(914)})());
1
+ !function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var a=n(r(279));t.default=a.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Metering API","version":"1.0.0"},"tags":[{"name":"Epilot_360","description":"Epilot_360"},{"name":"ECP","description":"End customer portal"}],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"paths":{"/v1/metering/meter":{"get":{"operationId":"getMeters","summary":"getMeters","description":"Get All meters for an Org","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Meter"}}}}}}}}}},"/v1/metering/counter":{"get":{"operationId":"getMeterCounters","summary":"getMeterCounters","description":"Get all counters for a given meter","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MeterCounter"}}}}}}}}}},"/v1/metering/counter/{id}":{"get":{"operationId":"getCounterDetails","summary":"getCounterDetails","description":"Get details for a meter counter","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MeterCounter"}}}}}}}}},"/v1/metering/reading":{"post":{"operationId":"createMeterReading","summary":"createMeterReading","description":"This operation inserts a new meter reading","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"requestBody":{"description":"Meter reading payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeterReading"}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MeterReading"}}}}}}}}},"/v1/metering/readings":{"post":{"operationId":"createMeterReadings","summary":"createMeterReadings","description":"This operation inserts a multiple meter readings at once, e.g; to submit bi-directional data (feed-in & feed-out) in a journey","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"requestBody":{"description":"Meter readings payload","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"readings":{"type":"array","items":{"$ref":"#/components/schemas/MeterReading"}}}}}}},"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MeterReading"}}}}}}}}},"/v1/metering/reading/{meter_id}/{counter_id}":{"get":{"operationId":"getReadingsByInterval","summary":"getReadingsByInterval","description":"- Get all readings specified in an interval\\n- If the start_date & end_date are equal, then returns the readings of the specified date\\n- start_date should <= end_date\\n","tags":["Epilot_360"],"security":[{"EpilotAuth":[]}],"parameters":[{"in":"path","name":"meter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of meter"},{"in":"path","name":"counter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of counter"},{"in":"query","name":"start_date","required":true,"schema":{"type":"string","example":"2022-10-01T00:00:00.000Z"}},{"in":"query","name":"end_date","required":true,"schema":{"type":"string","example":"2022-10-10T00:00:00.000Z"}},{"in":"query","name":"direction","required":false,"schema":{"$ref":"#/components/schemas/Direction"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MeterReading"}},"hits":{"type":"number","example":120}}}}}}}}},"/v1/metering/down-sample/readings/{meter_id}/{counter_id}":{"get":{"operationId":"getDownSampleReadingsByInterval","summary":"getDownSampleReadingsByInterval","description":"- Get the down sampled data of the entire readings specified in an interval\\n- If the start_date & end_date are equal, then returns the readings of the specified date\\n- start_date should <= end_date\\n","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"meter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of meter"},{"in":"path","name":"counter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of counter"},{"in":"query","name":"start_date","required":true,"schema":{"type":"string","example":"2022-10-01T00:00:00.000Z"}},{"in":"query","name":"end_date","required":true,"schema":{"type":"string","example":"2022-10-10T00:00:00.000Z"}},{"in":"query","name":"group_by","schema":{"type":"string","default":"day","enum":["day","week","month","year"]}},{"in":"query","name":"direction","required":false,"schema":{"$ref":"#/components/schemas/Direction"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MeterReading"}}}}}}}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Authorization header with epilot OAuth2 bearer token","bearerFormat":"JWT"},"CustomerPortalAuth":{"type":"http","scheme":"bearer","description":"Authorization header with customer pilot OAuth2 bearer token","bearerFormat":"JWT"}},"schemas":{"Id":{"type":"string"},"EntityRelation":{"type":"object","properties":{"entity_id":{"type":"string","example":"9a2081a2-1615-44b8-b988-d757983290dd"},"_slug":{"type":"string","enum":["contact","contract"]}}},"Meter":{"type":"object","properties":{"ma_lo_id":{"type":"string","example":"A09-123"},"meter_type":{"type":"string","enum":["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"]},"tariff_type":{"type":"string","example":"Peak load tariff"},"meter_number":{"type":"string","example":"J-1093-1AK"},"sector":{"type":"string","enum":["power","water","gas"]},"location":{"type":"object","example":[{"country":"Germany","city":"Koln","postal_code":81475,"street":"Melatengürtel","street_number":71,"additional_info":"5. Etage","_tags":["billing","delivery"]}]},"used_for":{"type":"string","example":"Domestic Usage"},"manufacturer":{"type":"string","example":"Energy One"},"calibration_date":{"type":"string","example":"2022-10-10T00:00:00.000Z"},"contract":{"type":"array","items":{"$ref":"#/components/schemas/EntityRelation"}},"billing_contact":{"type":"array","items":{"$ref":"#/components/schemas/EntityRelation"}}}},"Direction":{"type":"string","enum":["feed-in","feed-out"]},"MeterReading":{"type":"object","properties":{"value":{"type":"number","example":240},"read_by":{"type":"string","example":"John Doe"},"reason":{"type":"string","example":"Storing the feed-in record"},"meter_id":{"type":"string","example":"1446829f-4b6f-474e-b978-3997d89a7928"},"counter_id":{"type":"string","example":"A-34"},"direction":{"$ref":"#/components/schemas/Direction"}}},"MeterCounter":{"type":"object","properties":{"obis_number":{"type":"string","example":"A-34"},"direction":{"$ref":"#/components/schemas/Direction"},"transformer_ratio":{"type":"number","example":70},"unit":{"type":"string","enum":["w","wh","kw","kwh","kvarh","mw","mwh","unit","cubic-meter","hour","day","month","year","percentage"]},"forecast_reading_value":{"type":"string","example":270},"forecast_as_of":{"type":"string","example":"2022-12-10T00:00:00.000Z"},"current_consumption":{"type":"number","example":240},"conversion_factor":{"type":"number","example":3}}}}}}')}},t={};return function r(n){if(t[n])return t[n].exports;var a=t[n]={exports:{}};return e[n].call(a.exports,a,a.exports,r),a.exports}(914)})());
package/dist/openapi.d.ts CHANGED
@@ -9,14 +9,112 @@ import type {
9
9
 
10
10
  declare namespace Components {
11
11
  namespace Schemas {
12
+ export type Direction = "feed-in" | "feed-out";
13
+ export interface EntityRelation {
14
+ /**
15
+ * example:
16
+ * 9a2081a2-1615-44b8-b988-d757983290dd
17
+ */
18
+ entity_id?: string;
19
+ _slug?: "contact" | "contract";
20
+ }
12
21
  export type Id = string;
22
+ export interface Meter {
23
+ /**
24
+ * example:
25
+ * A09-123
26
+ */
27
+ ma_lo_id?: string;
28
+ 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";
29
+ /**
30
+ * example:
31
+ * Peak load tariff
32
+ */
33
+ tariff_type?: string;
34
+ /**
35
+ * example:
36
+ * J-1093-1AK
37
+ */
38
+ meter_number?: string;
39
+ sector?: "power" | "water" | "gas";
40
+ /**
41
+ * example:
42
+ * [
43
+ * {
44
+ * "country": "Germany",
45
+ * "city": "Koln",
46
+ * "postal_code": 81475,
47
+ * "street": "Melatengürtel",
48
+ * "street_number": 71,
49
+ * "additional_info": "5. Etage",
50
+ * "_tags": [
51
+ * "billing",
52
+ * "delivery"
53
+ * ]
54
+ * }
55
+ * ]
56
+ */
57
+ location?: {
58
+ [key: string]: any;
59
+ };
60
+ /**
61
+ * example:
62
+ * Domestic Usage
63
+ */
64
+ used_for?: string;
65
+ /**
66
+ * example:
67
+ * Energy One
68
+ */
69
+ manufacturer?: string;
70
+ /**
71
+ * example:
72
+ * "2022-10-10T00:00:00.000Z"
73
+ */
74
+ calibration_date?: string;
75
+ contract?: EntityRelation[];
76
+ billing_contact?: EntityRelation[];
77
+ }
78
+ export interface MeterCounter {
79
+ /**
80
+ * example:
81
+ * A-34
82
+ */
83
+ obis_number?: string;
84
+ direction?: Direction;
85
+ /**
86
+ * example:
87
+ * 70
88
+ */
89
+ transformer_ratio?: number;
90
+ unit?: "w" | "wh" | "kw" | "kwh" | "kvarh" | "mw" | "mwh" | "unit" | "cubic-meter" | "hour" | "day" | "month" | "year" | "percentage";
91
+ /**
92
+ * example:
93
+ * 270
94
+ */
95
+ forecast_reading_value?: string;
96
+ /**
97
+ * example:
98
+ * "2022-12-10T00:00:00.000Z"
99
+ */
100
+ forecast_as_of?: string;
101
+ /**
102
+ * example:
103
+ * 240
104
+ */
105
+ current_consumption?: number;
106
+ /**
107
+ * example:
108
+ * 3
109
+ */
110
+ conversion_factor?: number;
111
+ }
13
112
  export interface MeterReading {
14
113
  /**
15
114
  * example:
16
115
  * 240
17
116
  */
18
117
  value?: number;
19
- unit?: "W" | "WH" | "KW" | "KWH" | "KVARH" | "MW" | "MWH" | "unit" | "cubic meter" | "hour" | "day" | "month" | "year" | "percentage";
20
118
  /**
21
119
  * example:
22
120
  * John Doe
@@ -34,28 +132,55 @@ declare namespace Components {
34
132
  meter_id?: string;
35
133
  /**
36
134
  * example:
37
- * 2A-3
135
+ * A-34
38
136
  */
39
137
  counter_id?: string;
138
+ direction?: Direction;
40
139
  }
41
140
  }
42
141
  }
43
142
  declare namespace Paths {
44
- namespace FetchDownSampleReadingsByInterval {
143
+ namespace CreateMeterReading {
144
+ export type RequestBody = Components.Schemas.MeterReading;
145
+ namespace Responses {
146
+ export interface $200 {
147
+ data?: Components.Schemas.MeterReading;
148
+ }
149
+ }
150
+ }
151
+ namespace CreateMeterReadings {
152
+ export interface RequestBody {
153
+ readings?: Components.Schemas.MeterReading[];
154
+ }
155
+ namespace Responses {
156
+ export interface $200 {
157
+ data?: Components.Schemas.MeterReading;
158
+ }
159
+ }
160
+ }
161
+ namespace GetCounterDetails {
162
+ namespace Responses {
163
+ export interface $200 {
164
+ data?: Components.Schemas.MeterCounter;
165
+ }
166
+ }
167
+ }
168
+ namespace GetDownSampleReadingsByInterval {
45
169
  namespace Parameters {
46
170
  export type CounterId = Components.Schemas.Id;
171
+ export type Direction = Components.Schemas.Direction;
47
172
  /**
48
173
  * example:
49
174
  * "2022-10-10T00:00:00.000Z"
50
175
  */
51
176
  export type EndDate = string;
177
+ export type GroupBy = "day" | "week" | "month" | "year";
52
178
  export type MeterId = Components.Schemas.Id;
53
179
  /**
54
180
  * example:
55
181
  * "2022-10-01T00:00:00.000Z"
56
182
  */
57
183
  export type StartDate = string;
58
- export type Unit = "day" | "week" | "month" | "year";
59
184
  }
60
185
  export interface PathParameters {
61
186
  meter_id: Parameters.MeterId;
@@ -72,7 +197,8 @@ declare namespace Paths {
72
197
  * "2022-10-10T00:00:00.000Z"
73
198
  */
74
199
  Parameters.EndDate;
75
- unit?: Parameters.Unit;
200
+ group_by?: Parameters.GroupBy;
201
+ direction?: Parameters.Direction;
76
202
  }
77
203
  namespace Responses {
78
204
  export interface $200 {
@@ -80,9 +206,24 @@ declare namespace Paths {
80
206
  }
81
207
  }
82
208
  }
83
- namespace FetchReadingsByInterval {
209
+ namespace GetMeterCounters {
210
+ namespace Responses {
211
+ export interface $200 {
212
+ data?: Components.Schemas.MeterCounter[];
213
+ }
214
+ }
215
+ }
216
+ namespace GetMeters {
217
+ namespace Responses {
218
+ export interface $200 {
219
+ data?: Components.Schemas.Meter[];
220
+ }
221
+ }
222
+ }
223
+ namespace GetReadingsByInterval {
84
224
  namespace Parameters {
85
225
  export type CounterId = Components.Schemas.Id;
226
+ export type Direction = Components.Schemas.Direction;
86
227
  /**
87
228
  * example:
88
229
  * "2022-10-10T00:00:00.000Z"
@@ -110,6 +251,7 @@ declare namespace Paths {
110
251
  * "2022-10-10T00:00:00.000Z"
111
252
  */
112
253
  Parameters.EndDate;
254
+ direction?: Parameters.Direction;
113
255
  }
114
256
  namespace Responses {
115
257
  export interface $200 {
@@ -118,15 +260,7 @@ declare namespace Paths {
118
260
  * example:
119
261
  * 120
120
262
  */
121
- total_count?: number;
122
- }
123
- }
124
- }
125
- namespace SaveMeterReading {
126
- export type RequestBody = Components.Schemas.MeterReading;
127
- namespace Responses {
128
- export interface $200 {
129
- data?: Components.Schemas.MeterReading;
263
+ hits?: number;
130
264
  }
131
265
  }
132
266
  }
@@ -134,59 +268,147 @@ declare namespace Paths {
134
268
 
135
269
  export interface OperationMethods {
136
270
  /**
137
- * saveMeterReading - saveMeterReading
271
+ * getMeters - getMeters
272
+ *
273
+ * Get All meters for an Org
274
+ */
275
+ 'getMeters'(
276
+ parameters?: Parameters<UnknownParamsObject> | null,
277
+ data?: any,
278
+ config?: AxiosRequestConfig
279
+ ): OperationResponse<Paths.GetMeters.Responses.$200>
280
+ /**
281
+ * getMeterCounters - getMeterCounters
282
+ *
283
+ * Get all counters for a given meter
284
+ */
285
+ 'getMeterCounters'(
286
+ parameters?: Parameters<UnknownParamsObject> | null,
287
+ data?: any,
288
+ config?: AxiosRequestConfig
289
+ ): OperationResponse<Paths.GetMeterCounters.Responses.$200>
290
+ /**
291
+ * getCounterDetails - getCounterDetails
292
+ *
293
+ * Get details for a meter counter
294
+ */
295
+ 'getCounterDetails'(
296
+ parameters?: Parameters<UnknownParamsObject> | null,
297
+ data?: any,
298
+ config?: AxiosRequestConfig
299
+ ): OperationResponse<Paths.GetCounterDetails.Responses.$200>
300
+ /**
301
+ * createMeterReading - createMeterReading
138
302
  *
139
303
  * This operation inserts a new meter reading
140
304
  */
141
- 'saveMeterReading'(
305
+ 'createMeterReading'(
306
+ parameters?: Parameters<UnknownParamsObject> | null,
307
+ data?: Paths.CreateMeterReading.RequestBody,
308
+ config?: AxiosRequestConfig
309
+ ): OperationResponse<Paths.CreateMeterReading.Responses.$200>
310
+ /**
311
+ * createMeterReadings - createMeterReadings
312
+ *
313
+ * This operation inserts a multiple meter readings at once, e.g; to submit bi-directional data (feed-in & feed-out) in a journey
314
+ */
315
+ 'createMeterReadings'(
142
316
  parameters?: Parameters<UnknownParamsObject> | null,
143
- data?: Paths.SaveMeterReading.RequestBody,
317
+ data?: Paths.CreateMeterReadings.RequestBody,
144
318
  config?: AxiosRequestConfig
145
- ): OperationResponse<Paths.SaveMeterReading.Responses.$200>
319
+ ): OperationResponse<Paths.CreateMeterReadings.Responses.$200>
146
320
  /**
147
- * fetchReadingsByInterval - fetchReadingsByInterval
321
+ * getReadingsByInterval - getReadingsByInterval
148
322
  *
149
323
  * - Get all readings specified in an interval
150
324
  * - If the start_date & end_date are equal, then returns the readings of the specified date
151
325
  * - start_date should <= end_date
152
326
  *
153
327
  */
154
- 'fetchReadingsByInterval'(
155
- parameters?: Parameters<Paths.FetchReadingsByInterval.PathParameters & Paths.FetchReadingsByInterval.QueryParameters> | null,
328
+ 'getReadingsByInterval'(
329
+ parameters?: Parameters<Paths.GetReadingsByInterval.PathParameters & Paths.GetReadingsByInterval.QueryParameters> | null,
156
330
  data?: any,
157
331
  config?: AxiosRequestConfig
158
- ): OperationResponse<Paths.FetchReadingsByInterval.Responses.$200>
332
+ ): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
159
333
  /**
160
- * fetchDownSampleReadingsByInterval - fetchDownSampleReadingsByInterval
334
+ * getDownSampleReadingsByInterval - getDownSampleReadingsByInterval
161
335
  *
162
336
  * - Get the down sampled data of the entire readings specified in an interval
163
337
  * - If the start_date & end_date are equal, then returns the readings of the specified date
164
338
  * - start_date should <= end_date
165
339
  *
166
340
  */
167
- 'fetchDownSampleReadingsByInterval'(
168
- parameters?: Parameters<Paths.FetchDownSampleReadingsByInterval.PathParameters & Paths.FetchDownSampleReadingsByInterval.QueryParameters> | null,
341
+ 'getDownSampleReadingsByInterval'(
342
+ parameters?: Parameters<Paths.GetDownSampleReadingsByInterval.PathParameters & Paths.GetDownSampleReadingsByInterval.QueryParameters> | null,
169
343
  data?: any,
170
344
  config?: AxiosRequestConfig
171
- ): OperationResponse<Paths.FetchDownSampleReadingsByInterval.Responses.$200>
345
+ ): OperationResponse<Paths.GetDownSampleReadingsByInterval.Responses.$200>
172
346
  }
173
347
 
174
348
  export interface PathsDictionary {
349
+ ['/v1/metering/meter']: {
350
+ /**
351
+ * getMeters - getMeters
352
+ *
353
+ * Get All meters for an Org
354
+ */
355
+ 'get'(
356
+ parameters?: Parameters<UnknownParamsObject> | null,
357
+ data?: any,
358
+ config?: AxiosRequestConfig
359
+ ): OperationResponse<Paths.GetMeters.Responses.$200>
360
+ }
361
+ ['/v1/metering/counter']: {
362
+ /**
363
+ * getMeterCounters - getMeterCounters
364
+ *
365
+ * Get all counters for a given meter
366
+ */
367
+ 'get'(
368
+ parameters?: Parameters<UnknownParamsObject> | null,
369
+ data?: any,
370
+ config?: AxiosRequestConfig
371
+ ): OperationResponse<Paths.GetMeterCounters.Responses.$200>
372
+ }
373
+ ['/v1/metering/counter/{id}']: {
374
+ /**
375
+ * getCounterDetails - getCounterDetails
376
+ *
377
+ * Get details for a meter counter
378
+ */
379
+ 'get'(
380
+ parameters?: Parameters<UnknownParamsObject> | null,
381
+ data?: any,
382
+ config?: AxiosRequestConfig
383
+ ): OperationResponse<Paths.GetCounterDetails.Responses.$200>
384
+ }
175
385
  ['/v1/metering/reading']: {
176
386
  /**
177
- * saveMeterReading - saveMeterReading
387
+ * createMeterReading - createMeterReading
178
388
  *
179
389
  * This operation inserts a new meter reading
180
390
  */
181
391
  'post'(
182
392
  parameters?: Parameters<UnknownParamsObject> | null,
183
- data?: Paths.SaveMeterReading.RequestBody,
393
+ data?: Paths.CreateMeterReading.RequestBody,
394
+ config?: AxiosRequestConfig
395
+ ): OperationResponse<Paths.CreateMeterReading.Responses.$200>
396
+ }
397
+ ['/v1/metering/readings']: {
398
+ /**
399
+ * createMeterReadings - createMeterReadings
400
+ *
401
+ * This operation inserts a multiple meter readings at once, e.g; to submit bi-directional data (feed-in & feed-out) in a journey
402
+ */
403
+ 'post'(
404
+ parameters?: Parameters<UnknownParamsObject> | null,
405
+ data?: Paths.CreateMeterReadings.RequestBody,
184
406
  config?: AxiosRequestConfig
185
- ): OperationResponse<Paths.SaveMeterReading.Responses.$200>
407
+ ): OperationResponse<Paths.CreateMeterReadings.Responses.$200>
186
408
  }
187
409
  ['/v1/metering/reading/{meter_id}/{counter_id}']: {
188
410
  /**
189
- * fetchReadingsByInterval - fetchReadingsByInterval
411
+ * getReadingsByInterval - getReadingsByInterval
190
412
  *
191
413
  * - Get all readings specified in an interval
192
414
  * - If the start_date & end_date are equal, then returns the readings of the specified date
@@ -194,14 +416,14 @@ export interface PathsDictionary {
194
416
  *
195
417
  */
196
418
  'get'(
197
- parameters?: Parameters<Paths.FetchReadingsByInterval.PathParameters & Paths.FetchReadingsByInterval.QueryParameters> | null,
419
+ parameters?: Parameters<Paths.GetReadingsByInterval.PathParameters & Paths.GetReadingsByInterval.QueryParameters> | null,
198
420
  data?: any,
199
421
  config?: AxiosRequestConfig
200
- ): OperationResponse<Paths.FetchReadingsByInterval.Responses.$200>
422
+ ): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
201
423
  }
202
424
  ['/v1/metering/down-sample/readings/{meter_id}/{counter_id}']: {
203
425
  /**
204
- * fetchDownSampleReadingsByInterval - fetchDownSampleReadingsByInterval
426
+ * getDownSampleReadingsByInterval - getDownSampleReadingsByInterval
205
427
  *
206
428
  * - Get the down sampled data of the entire readings specified in an interval
207
429
  * - If the start_date & end_date are equal, then returns the readings of the specified date
@@ -209,10 +431,10 @@ export interface PathsDictionary {
209
431
  *
210
432
  */
211
433
  'get'(
212
- parameters?: Parameters<Paths.FetchDownSampleReadingsByInterval.PathParameters & Paths.FetchDownSampleReadingsByInterval.QueryParameters> | null,
434
+ parameters?: Parameters<Paths.GetDownSampleReadingsByInterval.PathParameters & Paths.GetDownSampleReadingsByInterval.QueryParameters> | null,
213
435
  data?: any,
214
436
  config?: AxiosRequestConfig
215
- ): OperationResponse<Paths.FetchDownSampleReadingsByInterval.Responses.$200>
437
+ ): OperationResponse<Paths.GetDownSampleReadingsByInterval.Responses.$200>
216
438
  }
217
439
  }
218
440
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/metering-client",
3
- "version": "0.1.1",
3
+ "version": "0.1.3",
4
4
  "description": "API Client for epilot Metering API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",