@epilot/metering-client 0.1.12 → 0.1.13
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/dist/definition.js +1 -1
- package/dist/openapi.d.ts +22 -18
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -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 a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=a(r(279));t.default=n.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":"
|
|
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 a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=a(r(279));t.default=n.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":"getCustomerMeters","summary":"getCustomerMeters","description":"Get All meters related to a customer","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":[]}],"parameters":[{"in":"query","name":"meter_id","required":true,"schema":{"type":"string","example":"1446829f-4b6f-474e-b978-3997d89a7928"}}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MeterCounter"}}}}}}}}}},"/v1/metering/counter/{counter_id}":{"get":{"operationId":"getCounterDetails","summary":"getCounterDetails","description":"Get details for a meter counter","tags":["ECP"],"security":[{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"counter_id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of a Counter"}],"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":false,"description":"If the value is not provided, the system will default to the date one year ago","schema":{"type":"string","example":"2022-10-01T00:00:00.000Z"}},{"in":"query","name":"end_date","required":false,"description":"If the value is not provided, the system will default to today","schema":{"type":"string","example":"2022-10-10T00:00:00.000Z"}},{"in":"query","name":"direction","required":false,"schema":{"$ref":"#/components/schemas/Direction"}},{"in":"query","name":"size","required":false,"schema":{"type":"integer","example":20,"default":20}},{"in":"query","name":"from","required":false,"schema":{"type":"integer","example":0,"default":0}}],"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":false,"description":"If the value is not provided, the system will default to the date one year ago","schema":{"type":"string","example":"2022-10-01T00:00:00.000Z"}},{"in":"query","name":"end_date","required":false,"description":"If the value is not provided, the system will default to today","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":{"data":{"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":{"_id":{"type":"string","example":"991a1821-43bc-46b8-967d-64a3d87c31f8"},"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":"object","properties":{"$relation":{"$ref":"#/components/schemas/EntityRelation"}}},"customer":{"type":"object","properties":{"$relation":{"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":"991a1821-43bc-46b8-967d-64a3d87c31f8"},"direction":{"$ref":"#/components/schemas/Direction"},"timestamp":{"type":"string","description":"If the value is not provided, the system will be set with the time the request is processed.","example":"2022-10-10T00:00:00.000Z"},"source":{"type":"string","enum":["ECP","ERP","360","journey-submission"]}}},"MeterCounter":{"type":"object","properties":{"_id":{"type":"string","example":"991a1821-43bc-46b8-967d-64a3d87c31f8"},"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},"last_reading":{"type":"string","example":"2022-10-10T00:00:00.000Z"},"conversion_factor":{"type":"number","example":3}}}}}}')}},t={};return function r(a){if(t[a])return t[a].exports;var n=t[a]={exports:{}};return e[a].call(n.exports,n,n.exports,r),n.exports}(914)})());
|
package/dist/openapi.d.ts
CHANGED
|
@@ -24,7 +24,7 @@ declare namespace Components {
|
|
|
24
24
|
* example:
|
|
25
25
|
* 991a1821-43bc-46b8-967d-64a3d87c31f8
|
|
26
26
|
*/
|
|
27
|
-
|
|
27
|
+
_id?: string;
|
|
28
28
|
/**
|
|
29
29
|
* example:
|
|
30
30
|
* A09-123
|
|
@@ -77,15 +77,19 @@ declare namespace Components {
|
|
|
77
77
|
* "2022-10-10T00:00:00.000Z"
|
|
78
78
|
*/
|
|
79
79
|
calibration_date?: string;
|
|
80
|
-
contract?:
|
|
81
|
-
|
|
80
|
+
contract?: {
|
|
81
|
+
$relation?: EntityRelation;
|
|
82
|
+
};
|
|
83
|
+
customer?: {
|
|
84
|
+
$relation?: EntityRelation[];
|
|
85
|
+
};
|
|
82
86
|
}
|
|
83
87
|
export interface MeterCounter {
|
|
84
88
|
/**
|
|
85
89
|
* example:
|
|
86
90
|
* 991a1821-43bc-46b8-967d-64a3d87c31f8
|
|
87
91
|
*/
|
|
88
|
-
|
|
92
|
+
_id?: string;
|
|
89
93
|
/**
|
|
90
94
|
* example:
|
|
91
95
|
* A-34
|
|
@@ -193,6 +197,13 @@ declare namespace Paths {
|
|
|
193
197
|
}
|
|
194
198
|
}
|
|
195
199
|
}
|
|
200
|
+
namespace GetCustomerMeters {
|
|
201
|
+
namespace Responses {
|
|
202
|
+
export interface $200 {
|
|
203
|
+
data?: Components.Schemas.Meter[];
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
}
|
|
196
207
|
namespace GetDownSampleReadingsByInterval {
|
|
197
208
|
namespace Parameters {
|
|
198
209
|
export type CounterId = Components.Schemas.Id;
|
|
@@ -255,13 +266,6 @@ declare namespace Paths {
|
|
|
255
266
|
}
|
|
256
267
|
}
|
|
257
268
|
}
|
|
258
|
-
namespace GetMeters {
|
|
259
|
-
namespace Responses {
|
|
260
|
-
export interface $200 {
|
|
261
|
-
data?: Components.Schemas.Meter[];
|
|
262
|
-
}
|
|
263
|
-
}
|
|
264
|
-
}
|
|
265
269
|
namespace GetReadingsByInterval {
|
|
266
270
|
namespace Parameters {
|
|
267
271
|
export type CounterId = Components.Schemas.Id;
|
|
@@ -330,15 +334,15 @@ declare namespace Paths {
|
|
|
330
334
|
|
|
331
335
|
export interface OperationMethods {
|
|
332
336
|
/**
|
|
333
|
-
*
|
|
337
|
+
* getCustomerMeters - getCustomerMeters
|
|
334
338
|
*
|
|
335
|
-
* Get All meters
|
|
339
|
+
* Get All meters related to a customer
|
|
336
340
|
*/
|
|
337
|
-
'
|
|
341
|
+
'getCustomerMeters'(
|
|
338
342
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
339
343
|
data?: any,
|
|
340
344
|
config?: AxiosRequestConfig
|
|
341
|
-
): OperationResponse<Paths.
|
|
345
|
+
): OperationResponse<Paths.GetCustomerMeters.Responses.$200>
|
|
342
346
|
/**
|
|
343
347
|
* getMeterCounters - getMeterCounters
|
|
344
348
|
*
|
|
@@ -410,15 +414,15 @@ export interface OperationMethods {
|
|
|
410
414
|
export interface PathsDictionary {
|
|
411
415
|
['/v1/metering/meter']: {
|
|
412
416
|
/**
|
|
413
|
-
*
|
|
417
|
+
* getCustomerMeters - getCustomerMeters
|
|
414
418
|
*
|
|
415
|
-
* Get All meters
|
|
419
|
+
* Get All meters related to a customer
|
|
416
420
|
*/
|
|
417
421
|
'get'(
|
|
418
422
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
419
423
|
data?: any,
|
|
420
424
|
config?: AxiosRequestConfig
|
|
421
|
-
): OperationResponse<Paths.
|
|
425
|
+
): OperationResponse<Paths.GetCustomerMeters.Responses.$200>
|
|
422
426
|
}
|
|
423
427
|
['/v1/metering/counter']: {
|
|
424
428
|
/**
|