@epilot/metering-client 0.5.5 → 0.5.6

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/openapi.d.ts CHANGED
@@ -12,17 +12,56 @@ declare namespace Components {
12
12
  export type Forbidden = Schemas.ErrorResp;
13
13
  export type InternalServerError = Schemas.ErrorResp;
14
14
  export type InvalidRequest = Schemas.ErrorResp;
15
- export type NotFound = Schemas.ErrorResp;
16
15
  export type Unauthorized = Schemas.ErrorResp;
17
16
  }
18
17
  namespace Schemas {
18
+ export interface ActionLabel {
19
+ en?: string | null;
20
+ de?: string | null;
21
+ }
22
+ export type AuthenticatedSubmission = {
23
+ /**
24
+ * The ID of the associated meter
25
+ */
26
+ meterId: Id;
27
+ /**
28
+ * - The counter readings of a meter
29
+ * - This is only sent when the user is authenticated while submitting a journey
30
+ *
31
+ */
32
+ readings?: CounterReadingOnSubmission[];
33
+ /**
34
+ * If the value is not provided, the system will be set with the time the request is processed.
35
+ * example:
36
+ * 2022-10-10T10:10:00.000Z
37
+ */
38
+ readingDate?: string;
39
+ /**
40
+ * The person who recorded the reading
41
+ * example:
42
+ * John Doe
43
+ */
44
+ readBy?: string;
45
+ /**
46
+ * The reason for recording the reading
47
+ * example:
48
+ * Storing the feed-in record
49
+ */
50
+ reason?: string;
51
+ /**
52
+ * The MA-LO ID of the meter
53
+ * example:
54
+ * A09-123
55
+ */
56
+ maloId?: string;
57
+ } | null;
19
58
  export interface BaseEntity {
20
59
  /**
21
60
  * Entity ID
22
61
  * example:
23
62
  * 3fa85f64-5717-4562-b3fc-2c963f66afa6
24
63
  */
25
- _id: EntityId;
64
+ _id: EntityId /* uuid */;
26
65
  /**
27
66
  * Title of the entity
28
67
  * example:
@@ -81,10 +120,10 @@ declare namespace Components {
81
120
  export interface Entity {
82
121
  [name: string]: any;
83
122
  }
84
- export type EntityId = string;
123
+ export type EntityId = string; // uuid
85
124
  export interface EntityItem {
86
125
  [name: string]: any;
87
- _id: EntityId;
126
+ _id: EntityId /* uuid */;
88
127
  /**
89
128
  * Title of the entity
90
129
  * example:
@@ -120,19 +159,9 @@ declare namespace Components {
120
159
  _updated_at: string; // date-time
121
160
  }
122
161
  export interface EntityRelation {
123
- /**
124
- * example:
125
- * 9a2081a2-1615-44b8-b988-d757983290dd
126
- */
127
- entity_id?: string;
162
+ entity_id?: EntityId /* uuid */;
128
163
  _slug?: "contact" | "contract";
129
164
  }
130
- /**
131
- * URL-friendly identifier for the entity schema
132
- * example:
133
- * contact
134
- */
135
- export type EntitySlug = string;
136
165
  export interface ErrorResp {
137
166
  /**
138
167
  * Error message
@@ -140,8 +169,14 @@ declare namespace Components {
140
169
  message?: string;
141
170
  }
142
171
  export type Id = string;
172
+ export interface JourneyActions {
173
+ journey_id?: string | null;
174
+ action_label?: ActionLabel;
175
+ slug?: string | null;
176
+ rules?: Rule[] | null;
177
+ }
143
178
  export interface Meter {
144
- _id: EntityId;
179
+ _id: EntityId /* uuid */;
145
180
  /**
146
181
  * Title of the entity
147
182
  * example:
@@ -258,7 +293,7 @@ declare namespace Components {
258
293
  };
259
294
  }
260
295
  export interface MeterCounter {
261
- _id: EntityId;
296
+ _id: EntityId /* uuid */;
262
297
  /**
263
298
  * Title of the entity
264
299
  * example:
@@ -360,16 +395,12 @@ declare namespace Components {
360
395
  reason?: string;
361
396
  /**
362
397
  * The ID of the associated meter
363
- * example:
364
- * 1446829f-4b6f-474e-b978-3997d89a7928
365
398
  */
366
- meter_id: string;
399
+ meter_id: EntityId /* uuid */;
367
400
  /**
368
401
  * The ID of the associated meter counter
369
- * example:
370
- * 991a1821-43bc-46b8-967d-64a3d87c31f8
371
402
  */
372
- counter_id?: string;
403
+ counter_id?: EntityId /* uuid */;
373
404
  /**
374
405
  * The direction of the reading (feed-in or feed-out)
375
406
  */
@@ -460,18 +491,19 @@ declare namespace Components {
460
491
  */
461
492
  source?: Source;
462
493
  }
494
+ export interface Rule {
495
+ entity?: string | null;
496
+ attribute?: string | null;
497
+ attribute_value?: string | null;
498
+ }
463
499
  export type Source = "ECP" | "ERP" | "360" | "journey-submission";
464
- export type SubmissionMeterReading = {
500
+ export type SubmissionMeterReading = AuthenticatedSubmission | UnauthenticatedSubmission;
501
+ export type TariffType = "ht" | "nt";
502
+ export type UnauthenticatedSubmission = {
465
503
  /**
466
504
  * The ID of the associated meter
467
505
  */
468
- meterId: Id;
469
- /**
470
- * - The counter readings of a meter
471
- * - This is only sent when the user is authenticated while submitting a journey
472
- *
473
- */
474
- readings?: CounterReadingOnSubmission[];
506
+ meterId?: Id;
475
507
  /**
476
508
  * The reading value of the meter when the counterId is passed or when the meterType is one-tariff
477
509
  * example:
@@ -502,12 +534,6 @@ declare namespace Components {
502
534
  * A09-123
503
535
  */
504
536
  maloId?: string;
505
- /**
506
- * The OBIS number of the meter counter
507
- * example:
508
- * A-34
509
- */
510
- obisNumber?: string;
511
537
  /**
512
538
  * The unit of measurement for the reading
513
539
  */
@@ -541,7 +567,6 @@ declare namespace Components {
541
567
  */
542
568
  ntValue?: number;
543
569
  } | null;
544
- export type TariffType = "ht" | "nt";
545
570
  export type Unit = "w" | "wh" | "kw" | "kWh" | "kvarh" | "mw" | "mWh" | "unit" | "cubic-meter" | "hour" | "day" | "month" | "year" | "percentage";
546
571
  }
547
572
  }
@@ -712,7 +737,124 @@ declare namespace Paths {
712
737
  namespace GetCustomerMeters {
713
738
  namespace Responses {
714
739
  export interface $200 {
715
- data?: Components.Schemas.Meter[];
740
+ data?: {
741
+ _id: Components.Schemas.EntityId /* uuid */;
742
+ /**
743
+ * Title of the entity
744
+ * example:
745
+ * Example Entity
746
+ */
747
+ _title: string;
748
+ /**
749
+ * Organization ID the entity belongs to
750
+ * example:
751
+ * 123
752
+ */
753
+ _org: string;
754
+ /**
755
+ * Array of entity tags
756
+ * example:
757
+ * [
758
+ * "example",
759
+ * "mock"
760
+ * ]
761
+ */
762
+ _tags?: string[];
763
+ /**
764
+ * Creation timestamp of the entity
765
+ * example:
766
+ * 2021-02-09T12:41:43.662Z
767
+ */
768
+ _created_at: string; // date-time
769
+ /**
770
+ * Last update timestamp of the entity
771
+ * example:
772
+ * 2021-02-09T12:41:43.662Z
773
+ */
774
+ _updated_at: string; // date-time
775
+ /**
776
+ * The schema type of the meter
777
+ */
778
+ _schema: "meter";
779
+ /**
780
+ * The MA-LO ID of the meter
781
+ * example:
782
+ * A09-123
783
+ */
784
+ ma_lo_id?: string;
785
+ /**
786
+ * The type of the meter
787
+ */
788
+ 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";
789
+ /**
790
+ * The tariff type of the meter
791
+ * example:
792
+ * Peak load tariff
793
+ */
794
+ tariff_type?: string;
795
+ /**
796
+ * The number of the meter
797
+ * example:
798
+ * J-1093-1AK
799
+ */
800
+ meter_number?: string;
801
+ /**
802
+ * The sector to which the meter belongs
803
+ */
804
+ sector?: "power" | "water" | "gas";
805
+ /**
806
+ * The location information of the meter
807
+ * example:
808
+ * [
809
+ * {
810
+ * "country": "Germany",
811
+ * "city": "Koln",
812
+ * "postal_code": 81475,
813
+ * "street": "Melatengürtel",
814
+ * "street_number": 71,
815
+ * "additional_info": "5. Etage",
816
+ * "_tags": [
817
+ * "billing",
818
+ * "delivery"
819
+ * ]
820
+ * }
821
+ * ]
822
+ */
823
+ location?: {
824
+ [key: string]: any;
825
+ };
826
+ /**
827
+ * The usage purpose of the meter
828
+ * example:
829
+ * Domestic Usage
830
+ */
831
+ used_for?: string;
832
+ /**
833
+ * The manufacturer of the meter
834
+ * example:
835
+ * Energy One
836
+ */
837
+ manufacturer?: string;
838
+ /**
839
+ * The calibration date of the meter
840
+ * example:
841
+ * 2022-10-10T00:00:00.000Z
842
+ */
843
+ calibration_date?: string;
844
+ /**
845
+ * The contract associated with the meter
846
+ */
847
+ contract?: {
848
+ $relation?: Components.Schemas.EntityRelation[];
849
+ };
850
+ /**
851
+ * The customer associated with the meter
852
+ */
853
+ customer?: {
854
+ $relation?: Components.Schemas.EntityRelation[];
855
+ };
856
+ journey_actions?: Components.Schemas.JourneyActions;
857
+ }[];
716
858
  }
717
859
  export type $400 = Components.Responses.InvalidRequest;
718
860
  export type $401 = Components.Responses.Unauthorized;
@@ -769,7 +911,7 @@ declare namespace Paths {
769
911
  }
770
912
  namespace GetMeter {
771
913
  namespace Parameters {
772
- export type Id = Components.Schemas.EntityId;
914
+ export type Id = Components.Schemas.EntityId /* uuid */;
773
915
  }
774
916
  export interface PathParameters {
775
917
  id: Parameters.Id;
@@ -778,6 +920,7 @@ declare namespace Paths {
778
920
  export interface $200 {
779
921
  data?: {
780
922
  entity?: Components.Schemas.Meter;
923
+ journey_actions?: Components.Schemas.JourneyActions;
781
924
  relations?: Components.Schemas.EntityItem[];
782
925
  };
783
926
  }
@@ -789,18 +932,10 @@ declare namespace Paths {
789
932
  }
790
933
  namespace GetMeterCounters {
791
934
  namespace Parameters {
792
- /**
793
- * example:
794
- * 1446829f-4b6f-474e-b978-3997d89a7928
795
- */
796
- export type MeterId = string;
935
+ export type MeterId = Components.Schemas.EntityId /* uuid */;
797
936
  }
798
937
  export interface QueryParameters {
799
- meter_id: /**
800
- * example:
801
- * 1446829f-4b6f-474e-b978-3997d89a7928
802
- */
803
- Parameters.MeterId;
938
+ meter_id: Parameters.MeterId;
804
939
  }
805
940
  namespace Responses {
806
941
  export interface $200 {
@@ -814,7 +949,7 @@ declare namespace Paths {
814
949
  }
815
950
  namespace GetMetersByContractId {
816
951
  namespace Parameters {
817
- export type ContractId = Components.Schemas.EntityId;
952
+ export type ContractId = Components.Schemas.EntityId /* uuid */;
818
953
  }
819
954
  export interface PathParameters {
820
955
  contract_id: Parameters.ContractId;
@@ -908,7 +1043,7 @@ declare namespace Paths {
908
1043
  }
909
1044
  namespace UpdateMeter {
910
1045
  namespace Parameters {
911
- export type Id = Components.Schemas.EntityId;
1046
+ export type Id = Components.Schemas.EntityId /* uuid */;
912
1047
  }
913
1048
  export interface PathParameters {
914
1049
  id: Parameters.Id;
@@ -975,7 +1110,7 @@ export interface OperationMethods {
975
1110
  * Retrieves all meters related to a contract.
976
1111
  */
977
1112
  'getMetersByContractId'(
978
- parameters: Parameters<Paths.GetMetersByContractId.PathParameters>,
1113
+ parameters?: Parameters<Paths.GetMetersByContractId.PathParameters> | null,
979
1114
  data?: any,
980
1115
  config?: AxiosRequestConfig
981
1116
  ): OperationResponse<Paths.GetMetersByContractId.Responses.$200>
@@ -985,7 +1120,7 @@ export interface OperationMethods {
985
1120
  * Retrieves the details of a meter.
986
1121
  */
987
1122
  'getMeter'(
988
- parameters: Parameters<Paths.GetMeter.PathParameters>,
1123
+ parameters?: Parameters<Paths.GetMeter.PathParameters> | null,
989
1124
  data?: any,
990
1125
  config?: AxiosRequestConfig
991
1126
  ): OperationResponse<Paths.GetMeter.Responses.$200>
@@ -995,7 +1130,7 @@ export interface OperationMethods {
995
1130
  * Updates the details of a meter.
996
1131
  */
997
1132
  'updateMeter'(
998
- parameters: Parameters<Paths.UpdateMeter.PathParameters>,
1133
+ parameters?: Parameters<Paths.UpdateMeter.PathParameters> | null,
999
1134
  data?: Paths.UpdateMeter.RequestBody,
1000
1135
  config?: AxiosRequestConfig
1001
1136
  ): OperationResponse<Paths.UpdateMeter.Responses.$200>
@@ -1015,7 +1150,7 @@ export interface OperationMethods {
1015
1150
  * Retrieves the details of a meter counter.
1016
1151
  */
1017
1152
  'getCounterDetails'(
1018
- parameters: Parameters<Paths.GetCounterDetails.PathParameters>,
1153
+ parameters?: Parameters<Paths.GetCounterDetails.PathParameters> | null,
1019
1154
  data?: any,
1020
1155
  config?: AxiosRequestConfig
1021
1156
  ): OperationResponse<Paths.GetCounterDetails.Responses.$200>
@@ -1055,7 +1190,7 @@ export interface OperationMethods {
1055
1190
  * Get allowed reading for the given meter
1056
1191
  */
1057
1192
  'getAllowedReadingForMeter'(
1058
- parameters: Parameters<Paths.GetAllowedReadingForMeter.QueryParameters & Paths.GetAllowedReadingForMeter.PathParameters>,
1193
+ parameters?: Parameters<Paths.GetAllowedReadingForMeter.PathParameters & Paths.GetAllowedReadingForMeter.QueryParameters> | null,
1059
1194
  data?: any,
1060
1195
  config?: AxiosRequestConfig
1061
1196
  ): OperationResponse<Paths.GetAllowedReadingForMeter.Responses.$200>
@@ -1078,7 +1213,7 @@ export interface OperationMethods {
1078
1213
  *
1079
1214
  */
1080
1215
  'getReadingsByInterval'(
1081
- parameters: Parameters<Paths.GetReadingsByInterval.QueryParameters & Paths.GetReadingsByInterval.PathParameters>,
1216
+ parameters?: Parameters<Paths.GetReadingsByInterval.PathParameters & Paths.GetReadingsByInterval.QueryParameters> | null,
1082
1217
  data?: any,
1083
1218
  config?: AxiosRequestConfig
1084
1219
  ): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
@@ -1088,7 +1223,7 @@ export interface OperationMethods {
1088
1223
  * Updates a meter reading.
1089
1224
  */
1090
1225
  'updateMeterReading'(
1091
- parameters: Parameters<Paths.UpdateMeterReading.QueryParameters & Paths.UpdateMeterReading.PathParameters>,
1226
+ parameters?: Parameters<Paths.UpdateMeterReading.PathParameters & Paths.UpdateMeterReading.QueryParameters> | null,
1092
1227
  data?: Paths.UpdateMeterReading.RequestBody,
1093
1228
  config?: AxiosRequestConfig
1094
1229
  ): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
@@ -1098,7 +1233,7 @@ export interface OperationMethods {
1098
1233
  * Deletes a meter reading.
1099
1234
  */
1100
1235
  'deleteMeterReading'(
1101
- parameters: Parameters<Paths.DeleteMeterReading.QueryParameters & Paths.DeleteMeterReading.PathParameters>,
1236
+ parameters?: Parameters<Paths.DeleteMeterReading.PathParameters & Paths.DeleteMeterReading.QueryParameters> | null,
1102
1237
  data?: any,
1103
1238
  config?: AxiosRequestConfig
1104
1239
  ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
@@ -1111,7 +1246,7 @@ export interface OperationMethods {
1111
1246
  *
1112
1247
  */
1113
1248
  'getDownSampleReadingsByInterval'(
1114
- parameters: Parameters<Paths.GetDownSampleReadingsByInterval.QueryParameters & Paths.GetDownSampleReadingsByInterval.PathParameters>,
1249
+ parameters?: Parameters<Paths.GetDownSampleReadingsByInterval.PathParameters & Paths.GetDownSampleReadingsByInterval.QueryParameters> | null,
1115
1250
  data?: any,
1116
1251
  config?: AxiosRequestConfig
1117
1252
  ): OperationResponse<Paths.GetDownSampleReadingsByInterval.Responses.$200>
@@ -1137,7 +1272,7 @@ export interface PathsDictionary {
1137
1272
  * Retrieves all meters related to a contract.
1138
1273
  */
1139
1274
  'get'(
1140
- parameters: Parameters<Paths.GetMetersByContractId.PathParameters>,
1275
+ parameters?: Parameters<Paths.GetMetersByContractId.PathParameters> | null,
1141
1276
  data?: any,
1142
1277
  config?: AxiosRequestConfig
1143
1278
  ): OperationResponse<Paths.GetMetersByContractId.Responses.$200>
@@ -1149,7 +1284,7 @@ export interface PathsDictionary {
1149
1284
  * Updates the details of a meter.
1150
1285
  */
1151
1286
  'patch'(
1152
- parameters: Parameters<Paths.UpdateMeter.PathParameters>,
1287
+ parameters?: Parameters<Paths.UpdateMeter.PathParameters> | null,
1153
1288
  data?: Paths.UpdateMeter.RequestBody,
1154
1289
  config?: AxiosRequestConfig
1155
1290
  ): OperationResponse<Paths.UpdateMeter.Responses.$200>
@@ -1159,7 +1294,7 @@ export interface PathsDictionary {
1159
1294
  * Retrieves the details of a meter.
1160
1295
  */
1161
1296
  'get'(
1162
- parameters: Parameters<Paths.GetMeter.PathParameters>,
1297
+ parameters?: Parameters<Paths.GetMeter.PathParameters> | null,
1163
1298
  data?: any,
1164
1299
  config?: AxiosRequestConfig
1165
1300
  ): OperationResponse<Paths.GetMeter.Responses.$200>
@@ -1183,7 +1318,7 @@ export interface PathsDictionary {
1183
1318
  * Retrieves the details of a meter counter.
1184
1319
  */
1185
1320
  'get'(
1186
- parameters: Parameters<Paths.GetCounterDetails.PathParameters>,
1321
+ parameters?: Parameters<Paths.GetCounterDetails.PathParameters> | null,
1187
1322
  data?: any,
1188
1323
  config?: AxiosRequestConfig
1189
1324
  ): OperationResponse<Paths.GetCounterDetails.Responses.$200>
@@ -1231,7 +1366,7 @@ export interface PathsDictionary {
1231
1366
  * Get allowed reading for the given meter
1232
1367
  */
1233
1368
  'get'(
1234
- parameters: Parameters<Paths.GetAllowedReadingForMeter.QueryParameters & Paths.GetAllowedReadingForMeter.PathParameters>,
1369
+ parameters?: Parameters<Paths.GetAllowedReadingForMeter.PathParameters & Paths.GetAllowedReadingForMeter.QueryParameters> | null,
1235
1370
  data?: any,
1236
1371
  config?: AxiosRequestConfig
1237
1372
  ): OperationResponse<Paths.GetAllowedReadingForMeter.Responses.$200>
@@ -1258,7 +1393,7 @@ export interface PathsDictionary {
1258
1393
  *
1259
1394
  */
1260
1395
  'get'(
1261
- parameters: Parameters<Paths.GetReadingsByInterval.QueryParameters & Paths.GetReadingsByInterval.PathParameters>,
1396
+ parameters?: Parameters<Paths.GetReadingsByInterval.PathParameters & Paths.GetReadingsByInterval.QueryParameters> | null,
1262
1397
  data?: any,
1263
1398
  config?: AxiosRequestConfig
1264
1399
  ): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
@@ -1268,7 +1403,7 @@ export interface PathsDictionary {
1268
1403
  * Updates a meter reading.
1269
1404
  */
1270
1405
  'put'(
1271
- parameters: Parameters<Paths.UpdateMeterReading.QueryParameters & Paths.UpdateMeterReading.PathParameters>,
1406
+ parameters?: Parameters<Paths.UpdateMeterReading.PathParameters & Paths.UpdateMeterReading.QueryParameters> | null,
1272
1407
  data?: Paths.UpdateMeterReading.RequestBody,
1273
1408
  config?: AxiosRequestConfig
1274
1409
  ): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
@@ -1278,7 +1413,7 @@ export interface PathsDictionary {
1278
1413
  * Deletes a meter reading.
1279
1414
  */
1280
1415
  'delete'(
1281
- parameters: Parameters<Paths.DeleteMeterReading.QueryParameters & Paths.DeleteMeterReading.PathParameters>,
1416
+ parameters?: Parameters<Paths.DeleteMeterReading.PathParameters & Paths.DeleteMeterReading.QueryParameters> | null,
1282
1417
  data?: any,
1283
1418
  config?: AxiosRequestConfig
1284
1419
  ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
@@ -1293,7 +1428,7 @@ export interface PathsDictionary {
1293
1428
  *
1294
1429
  */
1295
1430
  'get'(
1296
- parameters: Parameters<Paths.GetDownSampleReadingsByInterval.QueryParameters & Paths.GetDownSampleReadingsByInterval.PathParameters>,
1431
+ parameters?: Parameters<Paths.GetDownSampleReadingsByInterval.PathParameters & Paths.GetDownSampleReadingsByInterval.QueryParameters> | null,
1297
1432
  data?: any,
1298
1433
  config?: AxiosRequestConfig
1299
1434
  ): OperationResponse<Paths.GetDownSampleReadingsByInterval.Responses.$200>