@epilot/metering-client 0.1.16 → 0.1.18
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 +142 -1
- 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":"getCustomerMeters","summary":"getCustomerMeters","description":"Get All meters related to a customer","tags":["ECP"],"security":[{"EpilotAuth":[]},{"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":[{"EpilotAuth":[]},{"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":[{"EpilotAuth":[]},{"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","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":"direction","required":false,"schema":{"$ref":"#/components/schemas/Direction"}},{"in":"query","name":"size","description":"- Returns the first n results after the specified offset(from).\\n- If this value is provided with -1, then returns all results at once.\\n","required":false,"schema":{"type":"integer","example":20,"default":20}},{"in":"query","name":"from","required":false,"schema":{"type":"integer","example":0,"default":0}},{"in":"query","name":"type","required":true,"description":"- Since meter readings are cumulative, Users may need to request actual consumptions which are the difference between consecutive measurements.\\n- If this value is provided with \\"cumulative\\", then actual readings will be return.\\n- If this value is provided with \\"relative\\", then actual consumption will be return.\\n","schema":{"type":"string","default":"cumulative","enum":["cumulative","relative"]}}],"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":{"type":"array","items":{"$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)})());
|
|
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 i=a(r(279));t.default=i.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"},{"name":"Proxy","description":"Authorize with help of x-api-key"}],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"paths":{"/v1/metering/meter":{"get":{"operationId":"getCustomerMeters","summary":"getCustomerMeters","description":"Get All meters related to a customer","tags":["ECP"],"security":[{"EpilotAuth":[]},{"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":[{"EpilotAuth":[]},{"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":[{"EpilotAuth":[]},{"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/reading/{id}":{"put":{"operationId":"updateMeterReading","summary":"updateMeterReading","description":"This operation updates a meter reading","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of meter reading"}],"requestBody":{"description":"Update 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"}}}}}}}},"delete":{"operationId":"deleteMeterReading","summary":"deleteMeterReading","description":"This operation deletes a meter reading","tags":["Epilot_360","ECP"],"security":[{"EpilotAuth":[]},{"CustomerPortalAuth":[]}],"parameters":[{"in":"path","name":"id","schema":{"$ref":"#/components/schemas/Id"},"required":true,"description":"The Id of meter reading"}],"responses":{"200":{"description":"ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/Id"}}}}}}}}}}},"/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":{"type":"array","items":{"$ref":"#/components/schemas/MeterReading"}}}}}}}}}},"/v1/metering/reading/proxy":{"post":{"operationId":"createMeterReadingAsProxy","summary":"createMeterReadingAsProxy","description":"This operation lets to create reading with the help of valid x-api-key.","tags":["Proxy"],"security":[],"requestBody":{"description":"Meter reading payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyMeterReading"}}}},"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","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":"direction","required":false,"schema":{"$ref":"#/components/schemas/Direction"}},{"in":"query","name":"size","description":"- Returns the first n results after the specified offset(from).\\n- If this value is provided with -1, then returns all results at once.\\n","required":false,"schema":{"type":"number","example":20,"default":20}},{"in":"query","name":"from","required":false,"schema":{"type":"number","example":0,"default":0}},{"in":"query","name":"type","required":true,"description":"- Since meter readings are cumulative, Users may need to request actual consumptions which are the difference between consecutive measurements.\\n- If this value is provided with \\"cumulative\\", then actual readings will be return.\\n- If this value is provided with \\"relative\\", then actual consumption will be return.\\n","schema":{"type":"string","default":"cumulative","enum":["cumulative","relative"]}}],"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":{"type":"array","items":{"$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}}},"ProxyMeterReading":{"allOf":[{"$ref":"#/components/schemas/MeterReading"},{"type":"object","properties":{"_org":{"type":"string","example":123}}}]}}}}')}},t={};return function r(a){if(t[a])return t[a].exports;var i=t[a]={exports:{}};return e[a].call(i.exports,i,i.exports,r),i.exports}(914)})());
|
package/dist/openapi.d.ts
CHANGED
|
@@ -163,6 +163,46 @@ declare namespace Components {
|
|
|
163
163
|
timestamp?: string;
|
|
164
164
|
source?: "ECP" | "ERP" | "360" | "journey-submission";
|
|
165
165
|
}
|
|
166
|
+
export interface ProxyMeterReading {
|
|
167
|
+
/**
|
|
168
|
+
* example:
|
|
169
|
+
* 240
|
|
170
|
+
*/
|
|
171
|
+
value?: number;
|
|
172
|
+
/**
|
|
173
|
+
* example:
|
|
174
|
+
* John Doe
|
|
175
|
+
*/
|
|
176
|
+
read_by?: string;
|
|
177
|
+
/**
|
|
178
|
+
* example:
|
|
179
|
+
* Storing the feed-in record
|
|
180
|
+
*/
|
|
181
|
+
reason?: string;
|
|
182
|
+
/**
|
|
183
|
+
* example:
|
|
184
|
+
* 1446829f-4b6f-474e-b978-3997d89a7928
|
|
185
|
+
*/
|
|
186
|
+
meter_id?: string;
|
|
187
|
+
/**
|
|
188
|
+
* example:
|
|
189
|
+
* 991a1821-43bc-46b8-967d-64a3d87c31f8
|
|
190
|
+
*/
|
|
191
|
+
counter_id?: string;
|
|
192
|
+
direction?: Direction;
|
|
193
|
+
/**
|
|
194
|
+
* If the value is not provided, the system will be set with the time the request is processed.
|
|
195
|
+
* example:
|
|
196
|
+
* {}
|
|
197
|
+
*/
|
|
198
|
+
timestamp?: string;
|
|
199
|
+
source?: "ECP" | "ERP" | "360" | "journey-submission";
|
|
200
|
+
/**
|
|
201
|
+
* example:
|
|
202
|
+
* 123
|
|
203
|
+
*/
|
|
204
|
+
_org?: string;
|
|
205
|
+
}
|
|
166
206
|
}
|
|
167
207
|
}
|
|
168
208
|
declare namespace Paths {
|
|
@@ -174,13 +214,36 @@ declare namespace Paths {
|
|
|
174
214
|
}
|
|
175
215
|
}
|
|
176
216
|
}
|
|
217
|
+
namespace CreateMeterReadingAsProxy {
|
|
218
|
+
export type RequestBody = Components.Schemas.ProxyMeterReading;
|
|
219
|
+
namespace Responses {
|
|
220
|
+
export interface $200 {
|
|
221
|
+
data?: Components.Schemas.MeterReading;
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
}
|
|
177
225
|
namespace CreateMeterReadings {
|
|
178
226
|
export interface RequestBody {
|
|
179
227
|
readings?: Components.Schemas.MeterReading[];
|
|
180
228
|
}
|
|
181
229
|
namespace Responses {
|
|
182
230
|
export interface $200 {
|
|
183
|
-
data?: Components.Schemas.MeterReading;
|
|
231
|
+
data?: Components.Schemas.MeterReading[];
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
namespace DeleteMeterReading {
|
|
236
|
+
namespace Parameters {
|
|
237
|
+
export type Id = Components.Schemas.Id;
|
|
238
|
+
}
|
|
239
|
+
export interface PathParameters {
|
|
240
|
+
id: Parameters.Id;
|
|
241
|
+
}
|
|
242
|
+
namespace Responses {
|
|
243
|
+
export interface $200 {
|
|
244
|
+
data?: {
|
|
245
|
+
id?: Components.Schemas.Id;
|
|
246
|
+
};
|
|
184
247
|
}
|
|
185
248
|
}
|
|
186
249
|
}
|
|
@@ -332,6 +395,20 @@ declare namespace Paths {
|
|
|
332
395
|
}
|
|
333
396
|
}
|
|
334
397
|
}
|
|
398
|
+
namespace UpdateMeterReading {
|
|
399
|
+
namespace Parameters {
|
|
400
|
+
export type Id = Components.Schemas.Id;
|
|
401
|
+
}
|
|
402
|
+
export interface PathParameters {
|
|
403
|
+
id: Parameters.Id;
|
|
404
|
+
}
|
|
405
|
+
export type RequestBody = Components.Schemas.MeterReading;
|
|
406
|
+
namespace Responses {
|
|
407
|
+
export interface $200 {
|
|
408
|
+
data?: Components.Schemas.MeterReading;
|
|
409
|
+
}
|
|
410
|
+
}
|
|
411
|
+
}
|
|
335
412
|
}
|
|
336
413
|
|
|
337
414
|
export interface OperationMethods {
|
|
@@ -375,6 +452,26 @@ export interface OperationMethods {
|
|
|
375
452
|
data?: Paths.CreateMeterReading.RequestBody,
|
|
376
453
|
config?: AxiosRequestConfig
|
|
377
454
|
): OperationResponse<Paths.CreateMeterReading.Responses.$200>
|
|
455
|
+
/**
|
|
456
|
+
* updateMeterReading - updateMeterReading
|
|
457
|
+
*
|
|
458
|
+
* This operation updates a meter reading
|
|
459
|
+
*/
|
|
460
|
+
'updateMeterReading'(
|
|
461
|
+
parameters?: Parameters<Paths.UpdateMeterReading.PathParameters> | null,
|
|
462
|
+
data?: Paths.UpdateMeterReading.RequestBody,
|
|
463
|
+
config?: AxiosRequestConfig
|
|
464
|
+
): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
|
|
465
|
+
/**
|
|
466
|
+
* deleteMeterReading - deleteMeterReading
|
|
467
|
+
*
|
|
468
|
+
* This operation deletes a meter reading
|
|
469
|
+
*/
|
|
470
|
+
'deleteMeterReading'(
|
|
471
|
+
parameters?: Parameters<Paths.DeleteMeterReading.PathParameters> | null,
|
|
472
|
+
data?: any,
|
|
473
|
+
config?: AxiosRequestConfig
|
|
474
|
+
): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
|
|
378
475
|
/**
|
|
379
476
|
* createMeterReadings - createMeterReadings
|
|
380
477
|
*
|
|
@@ -385,6 +482,16 @@ export interface OperationMethods {
|
|
|
385
482
|
data?: Paths.CreateMeterReadings.RequestBody,
|
|
386
483
|
config?: AxiosRequestConfig
|
|
387
484
|
): OperationResponse<Paths.CreateMeterReadings.Responses.$200>
|
|
485
|
+
/**
|
|
486
|
+
* createMeterReadingAsProxy - createMeterReadingAsProxy
|
|
487
|
+
*
|
|
488
|
+
* This operation lets to create reading with the help of valid x-api-key.
|
|
489
|
+
*/
|
|
490
|
+
'createMeterReadingAsProxy'(
|
|
491
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
492
|
+
data?: Paths.CreateMeterReadingAsProxy.RequestBody,
|
|
493
|
+
config?: AxiosRequestConfig
|
|
494
|
+
): OperationResponse<Paths.CreateMeterReadingAsProxy.Responses.$200>
|
|
388
495
|
/**
|
|
389
496
|
* getReadingsByInterval - getReadingsByInterval
|
|
390
497
|
*
|
|
@@ -462,6 +569,28 @@ export interface PathsDictionary {
|
|
|
462
569
|
config?: AxiosRequestConfig
|
|
463
570
|
): OperationResponse<Paths.CreateMeterReading.Responses.$200>
|
|
464
571
|
}
|
|
572
|
+
['/v1/metering/reading/{id}']: {
|
|
573
|
+
/**
|
|
574
|
+
* updateMeterReading - updateMeterReading
|
|
575
|
+
*
|
|
576
|
+
* This operation updates a meter reading
|
|
577
|
+
*/
|
|
578
|
+
'put'(
|
|
579
|
+
parameters?: Parameters<Paths.UpdateMeterReading.PathParameters> | null,
|
|
580
|
+
data?: Paths.UpdateMeterReading.RequestBody,
|
|
581
|
+
config?: AxiosRequestConfig
|
|
582
|
+
): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
|
|
583
|
+
/**
|
|
584
|
+
* deleteMeterReading - deleteMeterReading
|
|
585
|
+
*
|
|
586
|
+
* This operation deletes a meter reading
|
|
587
|
+
*/
|
|
588
|
+
'delete'(
|
|
589
|
+
parameters?: Parameters<Paths.DeleteMeterReading.PathParameters> | null,
|
|
590
|
+
data?: any,
|
|
591
|
+
config?: AxiosRequestConfig
|
|
592
|
+
): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
|
|
593
|
+
}
|
|
465
594
|
['/v1/metering/readings']: {
|
|
466
595
|
/**
|
|
467
596
|
* createMeterReadings - createMeterReadings
|
|
@@ -474,6 +603,18 @@ export interface PathsDictionary {
|
|
|
474
603
|
config?: AxiosRequestConfig
|
|
475
604
|
): OperationResponse<Paths.CreateMeterReadings.Responses.$200>
|
|
476
605
|
}
|
|
606
|
+
['/v1/metering/reading/proxy']: {
|
|
607
|
+
/**
|
|
608
|
+
* createMeterReadingAsProxy - createMeterReadingAsProxy
|
|
609
|
+
*
|
|
610
|
+
* This operation lets to create reading with the help of valid x-api-key.
|
|
611
|
+
*/
|
|
612
|
+
'post'(
|
|
613
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
614
|
+
data?: Paths.CreateMeterReadingAsProxy.RequestBody,
|
|
615
|
+
config?: AxiosRequestConfig
|
|
616
|
+
): OperationResponse<Paths.CreateMeterReadingAsProxy.Responses.$200>
|
|
617
|
+
}
|
|
477
618
|
['/v1/metering/reading/{meter_id}/{counter_id}']: {
|
|
478
619
|
/**
|
|
479
620
|
* getReadingsByInterval - getReadingsByInterval
|