@epilot/sdk 2.4.3 → 2.4.4-alpha.0

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.
Files changed (348) hide show
  1. package/README.md +1 -0
  2. package/definitions/app-runtime.json +1 -1
  3. package/definitions/app.json +346 -10
  4. package/definitions/calendar-runtime.json +1 -0
  5. package/definitions/calendar.json +675 -0
  6. package/definitions/customer-portal.json +29 -0
  7. package/definitions/notes.json +175 -130
  8. package/definitions/pricing.json +5 -1
  9. package/dist/README-46VYEGGW.js +7 -0
  10. package/dist/README-IVBISSWB.cjs +7 -0
  11. package/dist/{_index-HE4B6FOA.js → _index-5FB6F5YY.js} +3 -0
  12. package/dist/{_index-55HAH24D.cjs → _index-DB2VV4PQ.cjs} +4 -1
  13. package/dist/apis/_registry.d.ts +8 -0
  14. package/dist/apis/access-token.cjs +6 -6
  15. package/dist/apis/access-token.d.ts +9 -12
  16. package/dist/apis/access-token.js +1 -1
  17. package/dist/apis/address-suggestions.cjs +6 -6
  18. package/dist/apis/address-suggestions.d.ts +9 -12
  19. package/dist/apis/address-suggestions.js +1 -1
  20. package/dist/apis/address.cjs +6 -6
  21. package/dist/apis/address.d.ts +9 -12
  22. package/dist/apis/address.js +1 -1
  23. package/dist/apis/ai-agents.cjs +6 -6
  24. package/dist/apis/ai-agents.d.ts +9 -12
  25. package/dist/apis/ai-agents.js +1 -1
  26. package/dist/apis/app.cjs +6 -6
  27. package/dist/apis/app.d.ts +9 -12
  28. package/dist/apis/app.js +1 -1
  29. package/dist/apis/audit-logs.cjs +6 -6
  30. package/dist/apis/audit-logs.d.ts +9 -12
  31. package/dist/apis/audit-logs.js +1 -1
  32. package/dist/apis/automation.cjs +6 -6
  33. package/dist/apis/automation.d.ts +9 -12
  34. package/dist/apis/automation.js +1 -1
  35. package/dist/apis/billing.cjs +6 -6
  36. package/dist/apis/billing.d.ts +9 -12
  37. package/dist/apis/billing.js +1 -1
  38. package/dist/apis/blueprint-manifest.cjs +6 -6
  39. package/dist/apis/blueprint-manifest.d.ts +9 -12
  40. package/dist/apis/blueprint-manifest.js +1 -1
  41. package/dist/apis/calendar.cjs +38 -0
  42. package/dist/apis/calendar.d.ts +15 -0
  43. package/dist/apis/calendar.js +38 -0
  44. package/dist/apis/configuration-hub.cjs +6 -6
  45. package/dist/apis/configuration-hub.d.ts +9 -12
  46. package/dist/apis/configuration-hub.js +1 -1
  47. package/dist/apis/consent.cjs +6 -6
  48. package/dist/apis/consent.d.ts +9 -12
  49. package/dist/apis/consent.js +1 -1
  50. package/dist/apis/customer-portal.cjs +6 -6
  51. package/dist/apis/customer-portal.d.ts +9 -12
  52. package/dist/apis/customer-portal.js +1 -1
  53. package/dist/apis/dashboard.cjs +6 -6
  54. package/dist/apis/dashboard.d.ts +9 -12
  55. package/dist/apis/dashboard.js +1 -1
  56. package/dist/apis/data-governance.cjs +6 -6
  57. package/dist/apis/data-governance.d.ts +9 -12
  58. package/dist/apis/data-governance.js +1 -1
  59. package/dist/apis/deduplication.cjs +6 -6
  60. package/dist/apis/deduplication.d.ts +9 -12
  61. package/dist/apis/deduplication.js +1 -1
  62. package/dist/apis/design.cjs +6 -6
  63. package/dist/apis/design.d.ts +9 -12
  64. package/dist/apis/design.js +1 -1
  65. package/dist/apis/document.cjs +6 -6
  66. package/dist/apis/document.d.ts +9 -12
  67. package/dist/apis/document.js +1 -1
  68. package/dist/apis/email-settings.cjs +6 -6
  69. package/dist/apis/email-settings.d.ts +9 -12
  70. package/dist/apis/email-settings.js +1 -1
  71. package/dist/apis/email-template.cjs +6 -6
  72. package/dist/apis/email-template.d.ts +9 -12
  73. package/dist/apis/email-template.js +1 -1
  74. package/dist/apis/entity-mapping.cjs +6 -6
  75. package/dist/apis/entity-mapping.d.ts +9 -12
  76. package/dist/apis/entity-mapping.js +1 -1
  77. package/dist/apis/entity.cjs +6 -6
  78. package/dist/apis/entity.d.ts +9 -12
  79. package/dist/apis/entity.js +1 -1
  80. package/dist/apis/environments.cjs +6 -6
  81. package/dist/apis/environments.d.ts +9 -12
  82. package/dist/apis/environments.js +1 -1
  83. package/dist/apis/event-catalog.cjs +6 -6
  84. package/dist/apis/event-catalog.d.ts +9 -12
  85. package/dist/apis/event-catalog.js +1 -1
  86. package/dist/apis/file.cjs +6 -6
  87. package/dist/apis/file.d.ts +9 -12
  88. package/dist/apis/file.js +1 -1
  89. package/dist/apis/iban.cjs +6 -6
  90. package/dist/apis/iban.d.ts +9 -12
  91. package/dist/apis/iban.js +1 -1
  92. package/dist/apis/integration-toolkit.cjs +6 -6
  93. package/dist/apis/integration-toolkit.d.ts +9 -12
  94. package/dist/apis/integration-toolkit.js +1 -1
  95. package/dist/apis/journey.cjs +6 -6
  96. package/dist/apis/journey.d.ts +9 -12
  97. package/dist/apis/journey.js +1 -1
  98. package/dist/apis/kanban.cjs +6 -6
  99. package/dist/apis/kanban.d.ts +9 -12
  100. package/dist/apis/kanban.js +1 -1
  101. package/dist/apis/message.cjs +6 -6
  102. package/dist/apis/message.d.ts +9 -12
  103. package/dist/apis/message.js +1 -1
  104. package/dist/apis/metering.cjs +6 -6
  105. package/dist/apis/metering.d.ts +9 -12
  106. package/dist/apis/metering.js +1 -1
  107. package/dist/apis/notes.cjs +6 -6
  108. package/dist/apis/notes.d.ts +9 -12
  109. package/dist/apis/notes.js +1 -1
  110. package/dist/apis/notification.cjs +6 -6
  111. package/dist/apis/notification.d.ts +9 -12
  112. package/dist/apis/notification.js +1 -1
  113. package/dist/apis/organization.cjs +6 -6
  114. package/dist/apis/organization.d.ts +9 -12
  115. package/dist/apis/organization.js +1 -1
  116. package/dist/apis/partner-directory.cjs +6 -6
  117. package/dist/apis/partner-directory.d.ts +9 -12
  118. package/dist/apis/partner-directory.js +1 -1
  119. package/dist/apis/permissions.cjs +6 -6
  120. package/dist/apis/permissions.d.ts +9 -12
  121. package/dist/apis/permissions.js +1 -1
  122. package/dist/apis/pricing-tier.cjs +6 -6
  123. package/dist/apis/pricing-tier.d.ts +9 -12
  124. package/dist/apis/pricing-tier.js +1 -1
  125. package/dist/apis/pricing.cjs +6 -6
  126. package/dist/apis/pricing.d.ts +9 -12
  127. package/dist/apis/pricing.js +1 -1
  128. package/dist/apis/purpose.cjs +6 -6
  129. package/dist/apis/purpose.d.ts +9 -12
  130. package/dist/apis/purpose.js +1 -1
  131. package/dist/apis/query.cjs +6 -6
  132. package/dist/apis/query.d.ts +9 -12
  133. package/dist/apis/query.js +1 -1
  134. package/dist/apis/sandbox.cjs +6 -6
  135. package/dist/apis/sandbox.d.ts +9 -12
  136. package/dist/apis/sandbox.js +1 -1
  137. package/dist/apis/sharing.cjs +6 -6
  138. package/dist/apis/sharing.d.ts +9 -12
  139. package/dist/apis/sharing.js +1 -1
  140. package/dist/apis/submission.cjs +6 -6
  141. package/dist/apis/submission.d.ts +9 -12
  142. package/dist/apis/submission.js +1 -1
  143. package/dist/apis/target.cjs +6 -6
  144. package/dist/apis/target.d.ts +9 -591
  145. package/dist/apis/target.js +1 -1
  146. package/dist/apis/targeting.cjs +6 -6
  147. package/dist/apis/targeting.d.ts +9 -12
  148. package/dist/apis/targeting.js +1 -1
  149. package/dist/apis/template-variables.cjs +6 -6
  150. package/dist/apis/template-variables.d.ts +9 -12
  151. package/dist/apis/template-variables.js +1 -1
  152. package/dist/apis/user.cjs +6 -6
  153. package/dist/apis/user.d.ts +9 -12
  154. package/dist/apis/user.js +1 -1
  155. package/dist/apis/validation-rules.cjs +6 -6
  156. package/dist/apis/validation-rules.d.ts +9 -12
  157. package/dist/apis/validation-rules.js +1 -1
  158. package/dist/apis/webhooks.cjs +6 -6
  159. package/dist/apis/webhooks.d.ts +9 -12
  160. package/dist/apis/webhooks.js +1 -1
  161. package/dist/apis/workflow-definition.cjs +6 -6
  162. package/dist/apis/workflow-definition.d.ts +9 -12
  163. package/dist/apis/workflow-definition.js +1 -1
  164. package/dist/apis/workflow.cjs +6 -6
  165. package/dist/apis/workflow.d.ts +9 -12
  166. package/dist/apis/workflow.js +1 -1
  167. package/dist/authorize.d.ts +3 -0
  168. package/dist/bin/cli.d.ts +1 -0
  169. package/dist/bin/cli.js +1 -1
  170. package/dist/calendar-2YDAYG7S.cjs +7 -0
  171. package/dist/calendar-ACFIHQ2N.js +7 -0
  172. package/dist/calendar-runtime-6CMMEQMG.js +5 -0
  173. package/dist/calendar-runtime-G4SN5PDY.cjs +5 -0
  174. package/dist/{chunk-AM5TSEMU.cjs → chunk-CD4OX2U6.cjs} +4 -2
  175. package/dist/chunk-CKLEBO4K.cjs +14 -0
  176. package/dist/chunk-JNH37UUH.js +14 -0
  177. package/dist/{chunk-M25MI6ZX.js → chunk-TSV242UN.js} +4 -2
  178. package/dist/client-factory.d.ts +9 -0
  179. package/dist/client-map.d.ts +102 -0
  180. package/dist/compact.d.ts +22 -0
  181. package/dist/help.d.ts +12 -0
  182. package/dist/index.cjs +25 -17
  183. package/dist/index.d.ts +12 -180
  184. package/dist/index.js +21 -13
  185. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  186. package/dist/large-response.d.ts +9 -0
  187. package/dist/openapi.d.ts +12 -0
  188. package/dist/overrides.d.ts +9 -0
  189. package/dist/proxy.d.ts +14 -0
  190. package/dist/registry.d.ts +19 -0
  191. package/dist/retry.d.ts +11 -0
  192. package/dist/sdk.d.ts +29 -0
  193. package/dist/types.d.ts +53 -0
  194. package/docs/calendar.md +441 -0
  195. package/package.json +10 -1
  196. package/dist/README-6MG272KM.cjs +0 -7
  197. package/dist/README-7N542PBL.js +0 -7
  198. package/dist/access-token.d-CnmUTOlq.d.cts +0 -552
  199. package/dist/access-token.d-CnmUTOlq.d.ts +0 -552
  200. package/dist/address-suggestions.d-_YwTOR-9.d.cts +0 -339
  201. package/dist/address-suggestions.d-_YwTOR-9.d.ts +0 -339
  202. package/dist/address.d-CwAPOVxa.d.cts +0 -437
  203. package/dist/address.d-CwAPOVxa.d.ts +0 -437
  204. package/dist/ai-agents.d-OkXfr2bz.d.cts +0 -1339
  205. package/dist/ai-agents.d-OkXfr2bz.d.ts +0 -1339
  206. package/dist/apis/access-token.d.cts +0 -18
  207. package/dist/apis/address-suggestions.d.cts +0 -18
  208. package/dist/apis/address.d.cts +0 -18
  209. package/dist/apis/ai-agents.d.cts +0 -18
  210. package/dist/apis/app.d.cts +0 -18
  211. package/dist/apis/audit-logs.d.cts +0 -18
  212. package/dist/apis/automation.d.cts +0 -18
  213. package/dist/apis/billing.d.cts +0 -18
  214. package/dist/apis/blueprint-manifest.d.cts +0 -18
  215. package/dist/apis/configuration-hub.d.cts +0 -18
  216. package/dist/apis/consent.d.cts +0 -18
  217. package/dist/apis/customer-portal.d.cts +0 -18
  218. package/dist/apis/dashboard.d.cts +0 -18
  219. package/dist/apis/data-governance.d.cts +0 -18
  220. package/dist/apis/deduplication.d.cts +0 -18
  221. package/dist/apis/design.d.cts +0 -18
  222. package/dist/apis/document.d.cts +0 -18
  223. package/dist/apis/email-settings.d.cts +0 -18
  224. package/dist/apis/email-template.d.cts +0 -18
  225. package/dist/apis/entity-mapping.d.cts +0 -18
  226. package/dist/apis/entity.d.cts +0 -18
  227. package/dist/apis/environments.d.cts +0 -18
  228. package/dist/apis/event-catalog.d.cts +0 -18
  229. package/dist/apis/file.d.cts +0 -18
  230. package/dist/apis/iban.d.cts +0 -18
  231. package/dist/apis/integration-toolkit.d.cts +0 -18
  232. package/dist/apis/journey.d.cts +0 -18
  233. package/dist/apis/kanban.d.cts +0 -18
  234. package/dist/apis/message.d.cts +0 -18
  235. package/dist/apis/metering.d.cts +0 -18
  236. package/dist/apis/notes.d.cts +0 -18
  237. package/dist/apis/notification.d.cts +0 -18
  238. package/dist/apis/organization.d.cts +0 -18
  239. package/dist/apis/partner-directory.d.cts +0 -18
  240. package/dist/apis/permissions.d.cts +0 -18
  241. package/dist/apis/pricing-tier.d.cts +0 -18
  242. package/dist/apis/pricing.d.cts +0 -18
  243. package/dist/apis/purpose.d.cts +0 -18
  244. package/dist/apis/query.d.cts +0 -18
  245. package/dist/apis/sandbox.d.cts +0 -18
  246. package/dist/apis/sharing.d.cts +0 -18
  247. package/dist/apis/submission.d.cts +0 -18
  248. package/dist/apis/target.d.cts +0 -597
  249. package/dist/apis/targeting.d.cts +0 -18
  250. package/dist/apis/template-variables.d.cts +0 -18
  251. package/dist/apis/user.d.cts +0 -18
  252. package/dist/apis/validation-rules.d.cts +0 -18
  253. package/dist/apis/webhooks.d.cts +0 -18
  254. package/dist/apis/workflow-definition.d.cts +0 -18
  255. package/dist/apis/workflow.d.cts +0 -18
  256. package/dist/app.d-u7Dq42kU.d.cts +0 -3391
  257. package/dist/app.d-u7Dq42kU.d.ts +0 -3391
  258. package/dist/audit-logs.d-BRToFqeX.d.cts +0 -287
  259. package/dist/audit-logs.d-BRToFqeX.d.ts +0 -287
  260. package/dist/automation.d-Du6-uiz5.d.cts +0 -5283
  261. package/dist/automation.d-Du6-uiz5.d.ts +0 -5283
  262. package/dist/billing.d-Bs8Ku9qE.d.cts +0 -993
  263. package/dist/billing.d-Bs8Ku9qE.d.ts +0 -993
  264. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +0 -4343
  265. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +0 -4343
  266. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  267. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  268. package/dist/consent.d-C2PROHhX.d.cts +0 -265
  269. package/dist/consent.d-C2PROHhX.d.ts +0 -265
  270. package/dist/customer-portal.d-DyZ2n2dW.d.cts +0 -16728
  271. package/dist/customer-portal.d-DyZ2n2dW.d.ts +0 -16728
  272. package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
  273. package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
  274. package/dist/data-governance.d-BbZ466j5.d.cts +0 -1178
  275. package/dist/data-governance.d-BbZ466j5.d.ts +0 -1178
  276. package/dist/deduplication.d-D5GYddVu.d.cts +0 -218
  277. package/dist/deduplication.d-D5GYddVu.d.ts +0 -218
  278. package/dist/design.d-BRre8iLg.d.cts +0 -2346
  279. package/dist/design.d-BRre8iLg.d.ts +0 -2346
  280. package/dist/document.d-DN37pjdx.d.cts +0 -648
  281. package/dist/document.d-DN37pjdx.d.ts +0 -648
  282. package/dist/email-settings.d-B7Q_xT25.d.cts +0 -2417
  283. package/dist/email-settings.d-B7Q_xT25.d.ts +0 -2417
  284. package/dist/email-template.d-gtQkdaXM.d.cts +0 -1188
  285. package/dist/email-template.d-gtQkdaXM.d.ts +0 -1188
  286. package/dist/entity-mapping.d-DKSW3sfy.d.cts +0 -1092
  287. package/dist/entity-mapping.d-DKSW3sfy.d.ts +0 -1092
  288. package/dist/entity.d-BHR9dEon.d.cts +0 -18479
  289. package/dist/entity.d-BHR9dEon.d.ts +0 -18479
  290. package/dist/environments.d-BvqvN-PD.d.cts +0 -382
  291. package/dist/environments.d-BvqvN-PD.d.ts +0 -382
  292. package/dist/event-catalog.d-ENw6HO-w.d.cts +0 -1511
  293. package/dist/event-catalog.d-ENw6HO-w.d.ts +0 -1511
  294. package/dist/file.d-DcTJxjp7.d.cts +0 -2992
  295. package/dist/file.d-DcTJxjp7.d.ts +0 -2992
  296. package/dist/iban.d-BwdiGbxi.d.cts +0 -70
  297. package/dist/iban.d-BwdiGbxi.d.ts +0 -70
  298. package/dist/index.d.cts +0 -180
  299. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +0 -5796
  300. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +0 -5796
  301. package/dist/journey.d-ClXO0xK8.d.cts +0 -1931
  302. package/dist/journey.d-ClXO0xK8.d.ts +0 -1931
  303. package/dist/kanban.d-BHnSRCYW.d.cts +0 -760
  304. package/dist/kanban.d-BHnSRCYW.d.ts +0 -760
  305. package/dist/message.d-B5UuSqgw.d.cts +0 -3811
  306. package/dist/message.d-B5UuSqgw.d.ts +0 -3811
  307. package/dist/metering.d-DvtPv7wk.d.cts +0 -1841
  308. package/dist/metering.d-DvtPv7wk.d.ts +0 -1841
  309. package/dist/notes.d-BC-scR42.d.cts +0 -1046
  310. package/dist/notes.d-BC-scR42.d.ts +0 -1046
  311. package/dist/notification.d-BfBL3lga.d.cts +0 -1147
  312. package/dist/notification.d-BfBL3lga.d.ts +0 -1147
  313. package/dist/organization.d-DqwnNxMg.d.cts +0 -1271
  314. package/dist/organization.d-DqwnNxMg.d.ts +0 -1271
  315. package/dist/partner-directory.d-BCIjHoGs.d.cts +0 -2337
  316. package/dist/partner-directory.d-BCIjHoGs.d.ts +0 -2337
  317. package/dist/permissions.d-l6AT8SYP.d.cts +0 -1279
  318. package/dist/permissions.d-l6AT8SYP.d.ts +0 -1279
  319. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +0 -81
  320. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +0 -81
  321. package/dist/pricing.d-BHpMU4KU.d.cts +0 -12255
  322. package/dist/pricing.d-BHpMU4KU.d.ts +0 -12255
  323. package/dist/purpose.d-CbIYfTua.d.cts +0 -372
  324. package/dist/purpose.d-CbIYfTua.d.ts +0 -372
  325. package/dist/query.d-Cmp78IhZ.d.cts +0 -2375
  326. package/dist/query.d-Cmp78IhZ.d.ts +0 -2375
  327. package/dist/sandbox.d-BdbOFzDu.d.cts +0 -465
  328. package/dist/sandbox.d-BdbOFzDu.d.ts +0 -465
  329. package/dist/sharing.d-sOXq-gtz.d.cts +0 -571
  330. package/dist/sharing.d-sOXq-gtz.d.ts +0 -571
  331. package/dist/submission.d-BamwfhXw.d.cts +0 -469
  332. package/dist/submission.d-BamwfhXw.d.ts +0 -469
  333. package/dist/targeting.d-BNmcVsNS.d.cts +0 -2057
  334. package/dist/targeting.d-BNmcVsNS.d.ts +0 -2057
  335. package/dist/template-variables.d-Ble9TSBa.d.cts +0 -1320
  336. package/dist/template-variables.d-Ble9TSBa.d.ts +0 -1320
  337. package/dist/types-ChU9Acbv.d.cts +0 -37
  338. package/dist/types-ChU9Acbv.d.ts +0 -37
  339. package/dist/user.d-D18fe97W.d.cts +0 -2270
  340. package/dist/user.d-D18fe97W.d.ts +0 -2270
  341. package/dist/validation-rules.d-Db5c5zTf.d.cts +0 -807
  342. package/dist/validation-rules.d-Db5c5zTf.d.ts +0 -807
  343. package/dist/webhooks.d-pLHIL_io.d.cts +0 -1256
  344. package/dist/webhooks.d-pLHIL_io.d.ts +0 -1256
  345. package/dist/workflow-definition.d-DOeb0KVV.d.cts +0 -1922
  346. package/dist/workflow-definition.d-DOeb0KVV.d.ts +0 -1922
  347. package/dist/workflow.d-CMSKt8oN.d.cts +0 -3151
  348. package/dist/workflow.d-CMSKt8oN.d.ts +0 -3151
@@ -1,1841 +0,0 @@
1
- import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from metering-client */
4
- /* eslint-disable */
5
-
6
-
7
-
8
- declare namespace Components {
9
- namespace Parameters {
10
- export type ActivityIdQueryParam = /**
11
- * See https://github.com/ulid/spec
12
- * example:
13
- * 01F130Q52Q6MWSNS8N2AVXV4JN
14
- */
15
- Schemas.ActivityId /* ulid */;
16
- export type SkipValidationQueryParam = boolean;
17
- }
18
- export interface QueryParameters {
19
- ActivityIdQueryParam?: Parameters.ActivityIdQueryParam;
20
- SkipValidationQueryParam?: Parameters.SkipValidationQueryParam;
21
- }
22
- namespace Responses {
23
- export type Forbidden = Schemas.ErrorResp;
24
- export type InternalServerError = Schemas.ErrorResp;
25
- export type InvalidRequest = Schemas.ErrorResp;
26
- export interface InvalidRequestCreateMeterReading {
27
- /**
28
- * Error message
29
- */
30
- message?: string;
31
- reason?: "contract_period" | "no_counter" | "no_direction" | "timestamp_future" | "less_than_previous" | "greater_than_subsequent" | "meter_decommissioned";
32
- }
33
- export interface InvalidRequestCreateMeterReadingFromSubmission {
34
- /**
35
- * Error message
36
- */
37
- message?: string;
38
- reason?: "timestamp_future" | "less_than_previous" | "greater_than_subsequent";
39
- }
40
- export interface InvalidRequestCreateMeterReadings {
41
- /**
42
- * Error message
43
- */
44
- message?: string;
45
- reason?: "too_many_records" | "timestamp_future" | "duplicate_reading" | "less_than_previous" | "invalid_identifiers" | "multiple_readings_found";
46
- }
47
- export interface InvalidRequestCreateReadingWithMeter {
48
- /**
49
- * Error message
50
- */
51
- message?: string;
52
- reason?: "missing_params" | "timestamp_future" | "less_than_previous" | "contract_period" | "greater_than_subsequent";
53
- }
54
- export interface InvalidRequestUpdateMeter {
55
- /**
56
- * Error message
57
- */
58
- message?: string;
59
- reason?: "missing_params";
60
- }
61
- export interface InvalidRequestUpdateMeterReading {
62
- /**
63
- * Error message
64
- */
65
- message?: string;
66
- reason?: "missing_params" | "timestamp_future" | "less_than_previous" | "greater_than_subsequent";
67
- }
68
- export type NotFound = Schemas.ErrorResp;
69
- export type Unauthorized = Schemas.ErrorResp;
70
- }
71
- namespace Schemas {
72
- export interface ActionLabel {
73
- en?: string | null;
74
- de?: string | null;
75
- }
76
- /**
77
- * See https://github.com/ulid/spec
78
- * example:
79
- * 01F130Q52Q6MWSNS8N2AVXV4JN
80
- */
81
- export type ActivityId = string; // ulid
82
- export interface BaseEntity {
83
- /**
84
- * Entity ID
85
- * example:
86
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
87
- */
88
- _id: EntityId /* uuid */;
89
- /**
90
- * Title of the entity
91
- * example:
92
- * Example Entity
93
- */
94
- _title: string;
95
- /**
96
- * Organization ID the entity belongs to
97
- * example:
98
- * 123
99
- */
100
- _org: string;
101
- /**
102
- * Array of entity tags
103
- * example:
104
- * [
105
- * "example",
106
- * "mock"
107
- * ]
108
- */
109
- _tags?: string[];
110
- /**
111
- * Creation timestamp of the entity
112
- * example:
113
- * 2021-02-09T12:41:43.662Z
114
- */
115
- _created_at: string; // date-time
116
- /**
117
- * Last update timestamp of the entity
118
- * example:
119
- * 2021-02-09T12:41:43.662Z
120
- */
121
- _updated_at: string; // date-time
122
- }
123
- export interface CounterReadingOnSubmission {
124
- /**
125
- * The ID of the associated meter counter
126
- */
127
- counterId: Id;
128
- /**
129
- * The direction of the reading (feed-in or feed-out)
130
- */
131
- direction: Direction;
132
- unit?: Unit;
133
- /**
134
- * The reading value of the meter counter
135
- * example:
136
- * 240
137
- */
138
- value: number;
139
- }
140
- export type Direction = "feed-in" | "feed-out";
141
- export interface Entity {
142
- [name: string]: any;
143
- }
144
- export type EntityId = string; // uuid
145
- export interface EntityItem {
146
- [name: string]: any;
147
- _id: EntityId /* uuid */;
148
- /**
149
- * Title of the entity
150
- * example:
151
- * Example Entity
152
- */
153
- _title: string;
154
- /**
155
- * Organization ID the entity belongs to
156
- * example:
157
- * 123
158
- */
159
- _org: string;
160
- /**
161
- * Array of entity tags
162
- * example:
163
- * [
164
- * "example",
165
- * "mock"
166
- * ]
167
- */
168
- _tags?: string[];
169
- /**
170
- * Creation timestamp of the entity
171
- * example:
172
- * 2021-02-09T12:41:43.662Z
173
- */
174
- _created_at: string; // date-time
175
- /**
176
- * Last update timestamp of the entity
177
- * example:
178
- * 2021-02-09T12:41:43.662Z
179
- */
180
- _updated_at: string; // date-time
181
- }
182
- export interface EntityRelation {
183
- entity_id?: EntityId /* uuid */;
184
- _slug?: "contact" | "contract";
185
- }
186
- /**
187
- * URL-friendly identifier for the entity schema
188
- * example:
189
- * contact
190
- */
191
- export type EntitySlug = string;
192
- export interface ErrorResp {
193
- /**
194
- * Error message
195
- */
196
- message?: string;
197
- }
198
- export type Id = string;
199
- export interface JourneyActions {
200
- journey_id?: string | null;
201
- action_label?: ActionLabel;
202
- slug?: string | null;
203
- rules?: Rule[] | null;
204
- }
205
- export interface Meter {
206
- _id: EntityId /* uuid */;
207
- /**
208
- * Title of the entity
209
- * example:
210
- * Example Entity
211
- */
212
- _title: string;
213
- /**
214
- * Organization ID the entity belongs to
215
- * example:
216
- * 123
217
- */
218
- _org: string;
219
- /**
220
- * Array of entity tags
221
- * example:
222
- * [
223
- * "example",
224
- * "mock"
225
- * ]
226
- */
227
- _tags?: string[];
228
- /**
229
- * Creation timestamp of the entity
230
- * example:
231
- * 2021-02-09T12:41:43.662Z
232
- */
233
- _created_at: string; // date-time
234
- /**
235
- * Last update timestamp of the entity
236
- * example:
237
- * 2021-02-09T12:41:43.662Z
238
- */
239
- _updated_at: string; // date-time
240
- /**
241
- * The schema type of the meter
242
- */
243
- _schema: "meter";
244
- /**
245
- * The MA-LO ID of the meter
246
- * example:
247
- * A09-123
248
- */
249
- ma_lo_id?: string;
250
- /**
251
- * The status of the meter
252
- */
253
- status?: "active" | "decommissioned";
254
- /**
255
- * The type of the meter
256
- */
257
- 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";
258
- /**
259
- * The tariff type of the meter
260
- * example:
261
- * Peak load tariff
262
- */
263
- tariff_type?: string;
264
- /**
265
- * The number of the meter
266
- * example:
267
- * J-1093-1AK
268
- */
269
- meter_number?: string;
270
- /**
271
- * The sector to which the meter belongs
272
- */
273
- sector?: "power" | "water" | "gas" | "district_heating" | "waste_water";
274
- /**
275
- * The location information of the meter
276
- * example:
277
- * [
278
- * {
279
- * "country": "Germany",
280
- * "city": "Koln",
281
- * "postal_code": 81475,
282
- * "street": "Melatengürtel",
283
- * "street_number": 71,
284
- * "additional_info": "5. Etage",
285
- * "_tags": [
286
- * "billing",
287
- * "delivery"
288
- * ]
289
- * }
290
- * ]
291
- */
292
- location?: {
293
- [key: string]: any;
294
- };
295
- /**
296
- * The usage purpose of the meter
297
- * example:
298
- * Domestic Usage
299
- */
300
- used_for?: string;
301
- /**
302
- * The manufacturer of the meter
303
- * example:
304
- * Energy One
305
- */
306
- manufacturer?: string;
307
- /**
308
- * The calibration date of the meter
309
- * example:
310
- * 2022-10-10T00:00:00.000Z
311
- */
312
- calibration_date?: string;
313
- /**
314
- * The contract associated with the meter
315
- */
316
- contract?: {
317
- $relation?: EntityRelation[];
318
- };
319
- /**
320
- * The customer associated with the meter
321
- */
322
- customer?: {
323
- $relation?: EntityRelation[];
324
- };
325
- }
326
- export interface MeterCounter {
327
- _id: EntityId /* uuid */;
328
- /**
329
- * Title of the entity
330
- * example:
331
- * Example Entity
332
- */
333
- _title: string;
334
- /**
335
- * Organization ID the entity belongs to
336
- * example:
337
- * 123
338
- */
339
- _org: string;
340
- /**
341
- * Array of entity tags
342
- * example:
343
- * [
344
- * "example",
345
- * "mock"
346
- * ]
347
- */
348
- _tags?: string[];
349
- /**
350
- * Creation timestamp of the entity
351
- * example:
352
- * 2021-02-09T12:41:43.662Z
353
- */
354
- _created_at: string; // date-time
355
- /**
356
- * Last update timestamp of the entity
357
- * example:
358
- * 2021-02-09T12:41:43.662Z
359
- */
360
- _updated_at: string; // date-time
361
- _schema: "meter_counter";
362
- /**
363
- * The OBIS number of the meter counter
364
- * example:
365
- * A-34
366
- */
367
- obis_number?: string;
368
- direction?: Direction;
369
- /**
370
- * The transformer ratio of the meter counter
371
- * example:
372
- * 70
373
- */
374
- transformer_ratio?: number;
375
- unit?: Unit;
376
- /**
377
- * The forecast reading value of the meter counter
378
- * example:
379
- * 270
380
- */
381
- forecast_reading_value?: string;
382
- /**
383
- * The date as of which the forecast reading value is applicable
384
- * example:
385
- * 2022-12-10T00:00:00.000Z
386
- */
387
- forecast_as_of?: string;
388
- /**
389
- * The current consumption value of the meter counter
390
- * example:
391
- * 240
392
- */
393
- current_consumption?: number;
394
- /**
395
- * The timestamp of the last reading
396
- * example:
397
- * 2022-10-10T00:00:00.000Z
398
- */
399
- last_reading?: string;
400
- /**
401
- * The conversion factor for the meter counter
402
- * example:
403
- * 3
404
- */
405
- conversion_factor?: number;
406
- tariff_type?: TariffType;
407
- }
408
- export interface MeterReading {
409
- /**
410
- * The reading value of the meter
411
- * example:
412
- * 240
413
- */
414
- value: number;
415
- read_by?: /**
416
- * The person who recorded the reading
417
- * example:
418
- * John Doe
419
- */
420
- ReadBy;
421
- reason?: /**
422
- * The reason for recording the reading
423
- * If no reason is specified or left empty, the Epilot UI will show 'Regular' as the default display text
424
- *
425
- */
426
- Reason;
427
- meter_id: EntityId /* uuid */;
428
- counter_id?: EntityId /* uuid */;
429
- direction?: Direction;
430
- /**
431
- * If the value is not provided, the system will be set with the time the request is processed.
432
- * example:
433
- * 2022-10-10T00:00:00.000Z
434
- */
435
- timestamp?: string; // date-time
436
- source: Source;
437
- status?: ReadingStatus;
438
- /**
439
- * The external ID of the reading
440
- */
441
- external_id?: string;
442
- /**
443
- * A remark or comment for the reading
444
- * example:
445
- * Customer reported unusual consumption
446
- */
447
- remark?: string | null;
448
- /**
449
- * Additional metadata for the reading
450
- * example:
451
- * {
452
- * "registration_id": "1234567890",
453
- * "business_unit": "ABC"
454
- * }
455
- */
456
- metadata?: {
457
- [name: string]: string;
458
- };
459
- /**
460
- * Notes to record a meter reading
461
- */
462
- note?: string;
463
- unit?: Unit;
464
- }
465
- export interface PortalMeterReading {
466
- /**
467
- * The reading value of the meter
468
- * example:
469
- * 240
470
- */
471
- value: number;
472
- read_by?: /**
473
- * The person who recorded the reading
474
- * example:
475
- * John Doe
476
- */
477
- ReadBy;
478
- reason?: /**
479
- * The reason for recording the reading
480
- * If no reason is specified or left empty, the Epilot UI will show 'Regular' as the default display text
481
- *
482
- */
483
- Reason;
484
- meter_id?: EntityId /* uuid */;
485
- counter_id: EntityId /* uuid */;
486
- direction?: Direction;
487
- /**
488
- * If the value is not provided, the system will be set with the time the request is processed.
489
- * example:
490
- * 2022-10-10T00:00:00.000Z
491
- */
492
- timestamp?: string; // date-time
493
- source: Source;
494
- status?: ReadingStatus;
495
- /**
496
- * The external ID of the reading
497
- */
498
- external_id?: string;
499
- /**
500
- * A remark or comment for the reading
501
- * example:
502
- * Customer reported unusual consumption
503
- */
504
- remark?: string | null;
505
- /**
506
- * Additional metadata for the reading
507
- * example:
508
- * {
509
- * "registration_id": "1234567890",
510
- * "business_unit": "ABC"
511
- * }
512
- */
513
- metadata?: {
514
- [name: string]: string;
515
- };
516
- /**
517
- * Notes to record a meter reading
518
- */
519
- note?: string;
520
- unit?: Unit;
521
- }
522
- /**
523
- * The person who recorded the reading
524
- * example:
525
- * John Doe
526
- */
527
- export type ReadBy = string | null;
528
- export interface Reading {
529
- /**
530
- * The reading value of the meter
531
- * example:
532
- * 240
533
- */
534
- value: number;
535
- read_by?: /**
536
- * The person who recorded the reading
537
- * example:
538
- * John Doe
539
- */
540
- ReadBy;
541
- reason?: /**
542
- * The reason for recording the reading
543
- * If no reason is specified or left empty, the Epilot UI will show 'Regular' as the default display text
544
- *
545
- */
546
- Reason;
547
- /**
548
- * The ID of the associated meter
549
- */
550
- meter_id?: EntityId /* uuid */;
551
- /**
552
- * The ID of the associated meter counter
553
- */
554
- counter_id?: EntityId /* uuid */;
555
- /**
556
- * The direction of the reading (feed-in or feed-out)
557
- */
558
- direction?: Direction;
559
- /**
560
- * If the value is not provided, the system will be set with the time the request is processed.
561
- * example:
562
- * 2022-10-10T00:00:00.000Z
563
- */
564
- timestamp?: string; // date-time
565
- /**
566
- * The source of the reading
567
- */
568
- source: Source;
569
- /**
570
- * The status of the reading
571
- */
572
- status?: ReadingStatus;
573
- /**
574
- * The external ID of the reading
575
- */
576
- external_id?: string;
577
- /**
578
- * A remark or comment for the reading
579
- * example:
580
- * Customer reported unusual consumption
581
- */
582
- remark?: string | null;
583
- /**
584
- * Additional metadata for the reading
585
- * example:
586
- * {
587
- * "registration_id": "1234567890",
588
- * "business_unit": "ABC"
589
- * }
590
- */
591
- metadata?: {
592
- [name: string]: string;
593
- };
594
- /**
595
- * Notes to record a meter reading
596
- */
597
- note?: string;
598
- /**
599
- * The unit of measurement for the reading
600
- */
601
- unit?: Unit;
602
- }
603
- export type ReadingStatus = "valid" | "in-validation" | "implausible" | null | "";
604
- export interface ReadingWithMeter {
605
- /**
606
- * The MA-LO ID of the meter
607
- * example:
608
- * A09-123
609
- */
610
- ma_lo_id?: string;
611
- /**
612
- * The ID of the associated meter
613
- */
614
- meter_id?: Id;
615
- /**
616
- * The OBIS number of the meter counter
617
- * example:
618
- * A-34
619
- */
620
- obis_number?: string;
621
- /**
622
- * The unit of measurement for the reading
623
- */
624
- unit?: Unit;
625
- /**
626
- * The direction of the reading
627
- */
628
- direction?: Direction;
629
- /**
630
- * The tariff type of the reading
631
- */
632
- tariff_type?: TariffType;
633
- /**
634
- * The reading value
635
- * example:
636
- * 240
637
- */
638
- value?: number;
639
- read_by?: /**
640
- * The person who recorded the reading
641
- * example:
642
- * John Doe
643
- */
644
- ReadBy;
645
- reason?: /**
646
- * The reason for recording the reading
647
- * If no reason is specified or left empty, the Epilot UI will show 'Regular' as the default display text
648
- *
649
- */
650
- Reason;
651
- /**
652
- * If the value is not provided, the system will be set with the time the request is processed.
653
- * example:
654
- * 2022-10-10T10:10:00.000Z
655
- */
656
- timestamp?: string;
657
- /**
658
- * The source of the reading
659
- */
660
- source?: Source;
661
- }
662
- /**
663
- * The reason for recording the reading
664
- * If no reason is specified or left empty, the Epilot UI will show 'Regular' as the default display text
665
- *
666
- */
667
- export type Reason = "" | "regular" | "irregular" | "last" | "first" | "meter_change" | "contract_change" | "meter_adjustment";
668
- /**
669
- * This field is deprecated. Please use the Reason enum instead.
670
- *
671
- */
672
- export type ReasonString = string | null;
673
- export interface Rule {
674
- entity?: string | null;
675
- attribute?: string | null;
676
- attribute_value?: string | null;
677
- }
678
- export type Source = "ECP" | "ERP" | "360" | "journey-submission";
679
- export type SubmissionMeterReading = {
680
- /**
681
- * The ID of the associated meter
682
- */
683
- meterId: Id;
684
- /**
685
- * - The counter readings of a meter
686
- * - This is only sent when the user is authenticated while submitting a journey
687
- *
688
- */
689
- readings?: CounterReadingOnSubmission[];
690
- /**
691
- * The reading value of the meter when the counterId is passed or when the meterType is one-tariff
692
- * example:
693
- * 240
694
- */
695
- readingValue?: number;
696
- /**
697
- * If the value is not provided, the system will be set with the time the request is processed.
698
- * example:
699
- * 2022-10-10T10:10:00.000Z
700
- */
701
- readingDate?: string;
702
- /**
703
- * The person who recorded the reading
704
- * example:
705
- * John Doe
706
- */
707
- readBy?: string;
708
- reason?: /**
709
- * The reason for recording the reading
710
- * If no reason is specified or left empty, the Epilot UI will show 'Regular' as the default display text
711
- *
712
- */
713
- Reason;
714
- /**
715
- * The MA-LO ID of the meter
716
- * example:
717
- * A09-123
718
- */
719
- maloId?: string;
720
- /**
721
- * The OBIS number of the meter counter
722
- * example:
723
- * A-34
724
- */
725
- obisNumber?: string;
726
- /**
727
- * The unit of measurement for the reading
728
- */
729
- readingUnit?: Unit;
730
- /**
731
- * The type of the meter
732
- */
733
- meterType?: "one_tariff" | "two_tariff" | "bi_directional";
734
- /**
735
- * The feed-in value of the meter when meterType is one-tariff or bi-directional
736
- * example:
737
- * 240
738
- */
739
- feedInValue?: number;
740
- /**
741
- * The feed-out value of the meter when meterType is bi-directional
742
- * example:
743
- * 240
744
- */
745
- feedOutValue?: number;
746
- /**
747
- * The high-peak tariff value of the meter when meterType is two-tariff
748
- * example:
749
- * 240
750
- */
751
- htValue?: number;
752
- /**
753
- * The off-peak tariff value of the meter when meterType is two-tariff
754
- * example:
755
- * 240
756
- */
757
- ntValue?: number;
758
- } | null;
759
- export type TariffType = "ht" | "nt";
760
- export type Unit = string;
761
- export interface UpdateMeterReading {
762
- /**
763
- * The reading value of the meter
764
- * example:
765
- * 240
766
- */
767
- value: number;
768
- read_by?: /**
769
- * The person who recorded the reading
770
- * example:
771
- * John Doe
772
- */
773
- ReadBy;
774
- reason?: /**
775
- * This field is deprecated. Please use the Reason enum instead.
776
- *
777
- */
778
- ReasonString;
779
- /**
780
- * The ID of the associated meter
781
- */
782
- meter_id: EntityId /* uuid */;
783
- /**
784
- * The ID of the associated meter counter
785
- */
786
- counter_id?: EntityId /* uuid */;
787
- /**
788
- * The direction of the reading (feed-in or feed-out)
789
- */
790
- direction?: Direction;
791
- /**
792
- * If the value is not provided, the system will be set with the time the request is processed.
793
- * example:
794
- * 2022-10-10T00:00:00.000Z
795
- */
796
- timestamp?: string; // date-time
797
- /**
798
- * The source of the reading
799
- */
800
- source: Source;
801
- /**
802
- * The status of the reading
803
- */
804
- status?: ReadingStatus;
805
- /**
806
- * The external ID of the reading
807
- */
808
- external_id?: string;
809
- /**
810
- * A remark or comment for the reading
811
- * example:
812
- * Customer reported unusual consumption
813
- */
814
- remark?: string | null;
815
- /**
816
- * Additional metadata for the reading
817
- * example:
818
- * {
819
- * "registration_id": "1234567890",
820
- * "business_unit": "ABC"
821
- * }
822
- */
823
- metadata?: {
824
- [name: string]: string;
825
- };
826
- }
827
- }
828
- }
829
- declare namespace Paths {
830
- namespace BatchWriteMeterReadings {
831
- namespace Parameters {
832
- export type ActivityId = /**
833
- * See https://github.com/ulid/spec
834
- * example:
835
- * 01F130Q52Q6MWSNS8N2AVXV4JN
836
- */
837
- Components.Schemas.ActivityId /* ulid */;
838
- export type Async = boolean;
839
- export type SkipValidation = boolean;
840
- }
841
- export interface QueryParameters {
842
- async?: Parameters.Async;
843
- skip_validation?: Parameters.SkipValidation;
844
- activity_id?: Parameters.ActivityId;
845
- }
846
- export interface RequestBody {
847
- /**
848
- * - By default, the system will use combination of counter_id, meter_id, direction, and timestamp to identify a meter reading.
849
- * - Additional identifiers can be provided to identify a meter reading uniquely.
850
- * - Example:
851
- * - ["metadata.registration_id", "metadata.business_unit"]
852
- * - ["metadata.registration_id", "metadata.business_unit", "external_id"]
853
- *
854
- */
855
- identifiers?: string[];
856
- readings?: {
857
- /**
858
- * The reading value of the meter
859
- * example:
860
- * 240
861
- */
862
- value: number;
863
- read_by?: /**
864
- * The person who recorded the reading
865
- * example:
866
- * John Doe
867
- */
868
- Components.Schemas.ReadBy;
869
- reason?: /**
870
- * The reason for recording the reading
871
- * If no reason is specified or left empty, the Epilot UI will show 'Regular' as the default display text
872
- *
873
- */
874
- Components.Schemas.Reason;
875
- meter_id: Components.Schemas.EntityId /* uuid */;
876
- counter_id?: Components.Schemas.EntityId /* uuid */;
877
- direction?: Components.Schemas.Direction;
878
- /**
879
- * If the value is not provided, the system will be set with the time the request is processed.
880
- * example:
881
- * 2022-10-10T00:00:00.000Z
882
- */
883
- timestamp?: string; // date-time
884
- source: Components.Schemas.Source;
885
- status?: Components.Schemas.ReadingStatus;
886
- /**
887
- * The external ID of the reading
888
- */
889
- external_id?: string;
890
- /**
891
- * A remark or comment for the reading
892
- * example:
893
- * Customer reported unusual consumption
894
- */
895
- remark?: string | null;
896
- /**
897
- * Additional metadata for the reading
898
- * example:
899
- * {
900
- * "registration_id": "1234567890",
901
- * "business_unit": "ABC"
902
- * }
903
- */
904
- metadata?: {
905
- [name: string]: string;
906
- };
907
- /**
908
- * Notes to record a meter reading
909
- */
910
- note?: string;
911
- unit?: Components.Schemas.Unit;
912
- operation?: "create" | "update" | "delete";
913
- }[];
914
- }
915
- namespace Responses {
916
- export interface $200 {
917
- data?: Components.Schemas.MeterReading[];
918
- }
919
- export type $400 = Components.Responses.InvalidRequestCreateMeterReadings;
920
- export type $401 = Components.Responses.Unauthorized;
921
- export type $403 = Components.Responses.Forbidden;
922
- export type $500 = Components.Responses.InternalServerError;
923
- }
924
- }
925
- namespace CreateMeterReading {
926
- export type RequestBody = Components.Schemas.MeterReading;
927
- namespace Responses {
928
- export interface $200 {
929
- data?: Components.Schemas.MeterReading;
930
- }
931
- export type $400 = Components.Responses.InvalidRequestCreateMeterReading;
932
- export type $401 = Components.Responses.Unauthorized;
933
- export type $403 = Components.Responses.Forbidden;
934
- export type $500 = Components.Responses.InternalServerError;
935
- }
936
- }
937
- namespace CreateMeterReadingFromSubmission {
938
- export interface RequestBody {
939
- [name: string]: any;
940
- /**
941
- * ID of the organization
942
- * example:
943
- * 123
944
- */
945
- org_id?: string;
946
- entity?: {
947
- [name: string]: any;
948
- /**
949
- * ID of the organization
950
- * example:
951
- * 123
952
- */
953
- _org?: string;
954
- meterReadings?: Components.Schemas.SubmissionMeterReading[];
955
- };
956
- }
957
- namespace Responses {
958
- export interface $200 {
959
- message?: "Successfully Processed";
960
- }
961
- export type $400 = Components.Responses.InvalidRequestCreateMeterReadingFromSubmission;
962
- export type $401 = Components.Responses.Unauthorized;
963
- export type $403 = Components.Responses.Forbidden;
964
- export type $500 = Components.Responses.InternalServerError;
965
- }
966
- }
967
- namespace CreateMeterReadings {
968
- namespace Parameters {
969
- export type ActivityId = /**
970
- * See https://github.com/ulid/spec
971
- * example:
972
- * 01F130Q52Q6MWSNS8N2AVXV4JN
973
- */
974
- Components.Schemas.ActivityId /* ulid */;
975
- export type Async = boolean;
976
- export type SkipValidation = boolean;
977
- }
978
- export interface QueryParameters {
979
- async?: Parameters.Async;
980
- activity_id?: Parameters.ActivityId;
981
- skip_validation?: Parameters.SkipValidation;
982
- }
983
- export interface RequestBody {
984
- readings?: Components.Schemas.MeterReading[];
985
- }
986
- namespace Responses {
987
- export interface $200 {
988
- data?: Components.Schemas.MeterReading[];
989
- }
990
- export type $400 = Components.Responses.InvalidRequestCreateMeterReadings;
991
- export type $401 = Components.Responses.Unauthorized;
992
- export type $403 = Components.Responses.Forbidden;
993
- export type $500 = Components.Responses.InternalServerError;
994
- }
995
- }
996
- namespace CreatePortalMeterReadings {
997
- namespace Parameters {
998
- export type MeterId = Components.Schemas.Id;
999
- }
1000
- export interface PathParameters {
1001
- meter_id: Parameters.MeterId;
1002
- }
1003
- export interface RequestBody {
1004
- readings?: Components.Schemas.PortalMeterReading[];
1005
- }
1006
- namespace Responses {
1007
- export interface $200 {
1008
- data?: Components.Schemas.MeterReading[];
1009
- }
1010
- export type $400 = Components.Responses.InvalidRequestCreateMeterReadings;
1011
- export type $401 = Components.Responses.Unauthorized;
1012
- export type $403 = Components.Responses.Forbidden;
1013
- export type $500 = Components.Responses.InternalServerError;
1014
- }
1015
- }
1016
- namespace CreateReadingWithMeter {
1017
- export type RequestBody = Components.Schemas.ReadingWithMeter;
1018
- namespace Responses {
1019
- export interface $200 {
1020
- data?: Components.Schemas.MeterReading;
1021
- }
1022
- export type $400 = Components.Responses.InvalidRequestCreateReadingWithMeter;
1023
- export type $401 = Components.Responses.Unauthorized;
1024
- export type $403 = Components.Responses.Forbidden;
1025
- export type $500 = Components.Responses.InternalServerError;
1026
- }
1027
- }
1028
- namespace DeleteMeterReading {
1029
- namespace Parameters {
1030
- export type CounterId = Components.Schemas.Id;
1031
- export type MeterId = Components.Schemas.Id;
1032
- /**
1033
- * example:
1034
- * 2022-10-01T20:00:00.000Z
1035
- */
1036
- export type Timestamp = string;
1037
- }
1038
- export interface PathParameters {
1039
- meter_id: Parameters.MeterId;
1040
- counter_id: Parameters.CounterId;
1041
- }
1042
- export interface QueryParameters {
1043
- timestamp: /**
1044
- * example:
1045
- * 2022-10-01T20:00:00.000Z
1046
- */
1047
- Parameters.Timestamp;
1048
- }
1049
- namespace Responses {
1050
- export interface $200 {
1051
- data?: {
1052
- meterId?: Components.Schemas.Id;
1053
- counterId?: Components.Schemas.Id;
1054
- /**
1055
- * example:
1056
- * 2022-10-01T20:00:00.000Z
1057
- */
1058
- timestamp?: string;
1059
- };
1060
- }
1061
- export type $400 = Components.Responses.InvalidRequest;
1062
- export type $401 = Components.Responses.Unauthorized;
1063
- export type $403 = Components.Responses.Forbidden;
1064
- export type $500 = Components.Responses.InternalServerError;
1065
- }
1066
- }
1067
- namespace GetAllowedReadingForMeter {
1068
- namespace Parameters {
1069
- export type MeterId = Components.Schemas.Id;
1070
- /**
1071
- * example:
1072
- * 2022-10-01T10:10:00.000Z
1073
- */
1074
- export type Timestamp = string;
1075
- }
1076
- export interface PathParameters {
1077
- meter_id: Parameters.MeterId;
1078
- }
1079
- export interface QueryParameters {
1080
- timestamp?: /**
1081
- * example:
1082
- * 2022-10-01T10:10:00.000Z
1083
- */
1084
- Parameters.Timestamp;
1085
- }
1086
- namespace Responses {
1087
- export interface $200 {
1088
- data?: {
1089
- counter_id?: Components.Schemas.Id;
1090
- /**
1091
- * Minimum allowed reading value for the meter
1092
- */
1093
- min_value?: number;
1094
- /**
1095
- * Maximum allowed reading value for the meter
1096
- */
1097
- max_value?: number;
1098
- }[];
1099
- }
1100
- export type $400 = Components.Responses.InvalidRequest;
1101
- export type $401 = Components.Responses.Unauthorized;
1102
- export type $403 = Components.Responses.Forbidden;
1103
- export type $500 = Components.Responses.InternalServerError;
1104
- }
1105
- }
1106
- namespace GetCounterDetails {
1107
- namespace Parameters {
1108
- export type CounterId = Components.Schemas.Id;
1109
- }
1110
- export interface PathParameters {
1111
- counter_id: Parameters.CounterId;
1112
- }
1113
- namespace Responses {
1114
- export interface $200 {
1115
- data?: Components.Schemas.MeterCounter;
1116
- }
1117
- export type $400 = Components.Responses.InvalidRequest;
1118
- export type $401 = Components.Responses.Unauthorized;
1119
- export type $403 = Components.Responses.Forbidden;
1120
- export type $500 = Components.Responses.InternalServerError;
1121
- }
1122
- }
1123
- namespace GetCustomerMeters {
1124
- namespace Responses {
1125
- export interface $200 {
1126
- data?: {
1127
- _id: Components.Schemas.EntityId /* uuid */;
1128
- /**
1129
- * Title of the entity
1130
- * example:
1131
- * Example Entity
1132
- */
1133
- _title: string;
1134
- /**
1135
- * Organization ID the entity belongs to
1136
- * example:
1137
- * 123
1138
- */
1139
- _org: string;
1140
- /**
1141
- * Array of entity tags
1142
- * example:
1143
- * [
1144
- * "example",
1145
- * "mock"
1146
- * ]
1147
- */
1148
- _tags?: string[];
1149
- /**
1150
- * Creation timestamp of the entity
1151
- * example:
1152
- * 2021-02-09T12:41:43.662Z
1153
- */
1154
- _created_at: string; // date-time
1155
- /**
1156
- * Last update timestamp of the entity
1157
- * example:
1158
- * 2021-02-09T12:41:43.662Z
1159
- */
1160
- _updated_at: string; // date-time
1161
- /**
1162
- * The schema type of the meter
1163
- */
1164
- _schema: "meter";
1165
- /**
1166
- * The MA-LO ID of the meter
1167
- * example:
1168
- * A09-123
1169
- */
1170
- ma_lo_id?: string;
1171
- /**
1172
- * The status of the meter
1173
- */
1174
- status?: "active" | "decommissioned";
1175
- /**
1176
- * The type of the meter
1177
- */
1178
- 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";
1179
- /**
1180
- * The tariff type of the meter
1181
- * example:
1182
- * Peak load tariff
1183
- */
1184
- tariff_type?: string;
1185
- /**
1186
- * The number of the meter
1187
- * example:
1188
- * J-1093-1AK
1189
- */
1190
- meter_number?: string;
1191
- /**
1192
- * The sector to which the meter belongs
1193
- */
1194
- sector?: "power" | "water" | "gas" | "district_heating" | "waste_water";
1195
- /**
1196
- * The location information of the meter
1197
- * example:
1198
- * [
1199
- * {
1200
- * "country": "Germany",
1201
- * "city": "Koln",
1202
- * "postal_code": 81475,
1203
- * "street": "Melatengürtel",
1204
- * "street_number": 71,
1205
- * "additional_info": "5. Etage",
1206
- * "_tags": [
1207
- * "billing",
1208
- * "delivery"
1209
- * ]
1210
- * }
1211
- * ]
1212
- */
1213
- location?: {
1214
- [key: string]: any;
1215
- };
1216
- /**
1217
- * The usage purpose of the meter
1218
- * example:
1219
- * Domestic Usage
1220
- */
1221
- used_for?: string;
1222
- /**
1223
- * The manufacturer of the meter
1224
- * example:
1225
- * Energy One
1226
- */
1227
- manufacturer?: string;
1228
- /**
1229
- * The calibration date of the meter
1230
- * example:
1231
- * 2022-10-10T00:00:00.000Z
1232
- */
1233
- calibration_date?: string;
1234
- /**
1235
- * The contract associated with the meter
1236
- */
1237
- contract?: {
1238
- $relation?: Components.Schemas.EntityRelation[];
1239
- };
1240
- /**
1241
- * The customer associated with the meter
1242
- */
1243
- customer?: {
1244
- $relation?: Components.Schemas.EntityRelation[];
1245
- };
1246
- journey_actions?: Components.Schemas.JourneyActions;
1247
- /**
1248
- * The timestamp of the last reading
1249
- * example:
1250
- * 2022-10-10T00:00:00.000Z
1251
- */
1252
- last_reading?: string;
1253
- /**
1254
- * The current consumption of the meter
1255
- * example:
1256
- * 100.5
1257
- */
1258
- current_consumption?: number;
1259
- }[];
1260
- }
1261
- export type $400 = Components.Responses.InvalidRequest;
1262
- export type $401 = Components.Responses.Unauthorized;
1263
- export type $403 = Components.Responses.Forbidden;
1264
- export type $500 = Components.Responses.InternalServerError;
1265
- }
1266
- }
1267
- namespace GetMeter {
1268
- namespace Parameters {
1269
- export type Id = Components.Schemas.EntityId /* uuid */;
1270
- }
1271
- export interface PathParameters {
1272
- id: Parameters.Id;
1273
- }
1274
- namespace Responses {
1275
- export interface $200 {
1276
- data?: {
1277
- entity?: Components.Schemas.Meter;
1278
- journey_actions?: Components.Schemas.JourneyActions;
1279
- relations?: Components.Schemas.EntityItem[];
1280
- };
1281
- }
1282
- export type $400 = Components.Responses.InvalidRequest;
1283
- export type $401 = Components.Responses.Unauthorized;
1284
- export type $403 = Components.Responses.Forbidden;
1285
- export type $500 = Components.Responses.InternalServerError;
1286
- }
1287
- }
1288
- namespace GetMeterCounters {
1289
- namespace Parameters {
1290
- export type MeterId = Components.Schemas.EntityId /* uuid */;
1291
- }
1292
- export interface QueryParameters {
1293
- meter_id: Parameters.MeterId;
1294
- }
1295
- namespace Responses {
1296
- export interface $200 {
1297
- data?: Components.Schemas.MeterCounter[];
1298
- }
1299
- export type $400 = Components.Responses.InvalidRequest;
1300
- export type $401 = Components.Responses.Unauthorized;
1301
- export type $403 = Components.Responses.Forbidden;
1302
- export type $500 = Components.Responses.InternalServerError;
1303
- }
1304
- }
1305
- namespace GetMetersByContractId {
1306
- namespace Parameters {
1307
- export type ContractId = Components.Schemas.EntityId /* uuid */;
1308
- }
1309
- export interface PathParameters {
1310
- contract_id: Parameters.ContractId;
1311
- }
1312
- namespace Responses {
1313
- export interface $200 {
1314
- data?: Components.Schemas.Meter[];
1315
- }
1316
- export type $400 = Components.Responses.InvalidRequest;
1317
- export type $401 = Components.Responses.Unauthorized;
1318
- export type $403 = Components.Responses.Forbidden;
1319
- export type $500 = Components.Responses.InternalServerError;
1320
- }
1321
- }
1322
- namespace GetReadingsByInterval {
1323
- namespace Parameters {
1324
- export type CounterId = Components.Schemas.Id;
1325
- export type Direction = Components.Schemas.Direction;
1326
- /**
1327
- * example:
1328
- * 2022-10-10
1329
- */
1330
- export type EndDate = string;
1331
- /**
1332
- * example:
1333
- * 0
1334
- */
1335
- export type From = number;
1336
- export type MeterId = Components.Schemas.Id;
1337
- /**
1338
- * example:
1339
- * 20
1340
- */
1341
- export type Size = number;
1342
- export type Sort = "asc" | "desc";
1343
- /**
1344
- * example:
1345
- * 2022-10-01
1346
- */
1347
- export type StartDate = string;
1348
- export type Type = "cumulative" | "relative";
1349
- }
1350
- export interface PathParameters {
1351
- meter_id: Parameters.MeterId;
1352
- counter_id: Parameters.CounterId;
1353
- }
1354
- export interface QueryParameters {
1355
- start_date?: /**
1356
- * example:
1357
- * 2022-10-01
1358
- */
1359
- Parameters.StartDate;
1360
- end_date?: /**
1361
- * example:
1362
- * 2022-10-10
1363
- */
1364
- Parameters.EndDate;
1365
- direction?: Parameters.Direction;
1366
- size?: /**
1367
- * example:
1368
- * 20
1369
- */
1370
- Parameters.Size;
1371
- from?: /**
1372
- * example:
1373
- * 0
1374
- */
1375
- Parameters.From;
1376
- type: Parameters.Type;
1377
- sort?: Parameters.Sort;
1378
- }
1379
- namespace Responses {
1380
- export interface $200 {
1381
- results?: Components.Schemas.MeterReading[];
1382
- /**
1383
- * example:
1384
- * 120
1385
- */
1386
- hits?: number;
1387
- /**
1388
- * example:
1389
- * 2022-10-01T20:00:00.000Z
1390
- */
1391
- firstRecordCreatedAt?: string;
1392
- }
1393
- export type $400 = Components.Responses.InvalidRequest;
1394
- export type $401 = Components.Responses.Unauthorized;
1395
- export type $403 = Components.Responses.Forbidden;
1396
- export type $500 = Components.Responses.InternalServerError;
1397
- }
1398
- }
1399
- namespace UpdateMeter {
1400
- namespace Parameters {
1401
- export type Id = Components.Schemas.EntityId /* uuid */;
1402
- }
1403
- export interface PathParameters {
1404
- id: Parameters.Id;
1405
- }
1406
- export type RequestBody = Components.Schemas.Entity;
1407
- namespace Responses {
1408
- export interface $200 {
1409
- data?: Components.Schemas.Meter;
1410
- }
1411
- export type $400 = Components.Responses.InvalidRequestUpdateMeter;
1412
- export type $401 = Components.Responses.Unauthorized;
1413
- export type $403 = Components.Responses.Forbidden;
1414
- export type $500 = Components.Responses.InternalServerError;
1415
- }
1416
- }
1417
- namespace UpdateMeterReading {
1418
- namespace Parameters {
1419
- export type CounterId = Components.Schemas.Id;
1420
- export type MeterId = Components.Schemas.Id;
1421
- /**
1422
- * example:
1423
- * 2022-10-01T20:00:00.000Z
1424
- */
1425
- export type Timestamp = string;
1426
- }
1427
- export interface PathParameters {
1428
- meter_id: Parameters.MeterId;
1429
- counter_id: Parameters.CounterId;
1430
- }
1431
- export interface QueryParameters {
1432
- timestamp: /**
1433
- * example:
1434
- * 2022-10-01T20:00:00.000Z
1435
- */
1436
- Parameters.Timestamp;
1437
- }
1438
- export type RequestBody = Components.Schemas.UpdateMeterReading;
1439
- namespace Responses {
1440
- export interface $200 {
1441
- data?: Components.Schemas.MeterReading;
1442
- }
1443
- export type $400 = Components.Responses.InvalidRequestUpdateMeterReading;
1444
- export type $401 = Components.Responses.Unauthorized;
1445
- export type $403 = Components.Responses.Forbidden;
1446
- export type $500 = Components.Responses.InternalServerError;
1447
- }
1448
- }
1449
- }
1450
-
1451
- interface OperationMethods {
1452
- /**
1453
- * getCustomerMeters - Get Customer Meters
1454
- *
1455
- * Retrieves all meters related to a customer.
1456
- */
1457
- 'getCustomerMeters'(
1458
- parameters?: Parameters<UnknownParamsObject> | null,
1459
- data?: any,
1460
- config?: AxiosRequestConfig
1461
- ): OperationResponse<Paths.GetCustomerMeters.Responses.$200>
1462
- /**
1463
- * getMetersByContractId - getMetersByContractId
1464
- *
1465
- * Retrieves all meters related to a contract.
1466
- */
1467
- 'getMetersByContractId'(
1468
- parameters?: Parameters<Paths.GetMetersByContractId.PathParameters> | null,
1469
- data?: any,
1470
- config?: AxiosRequestConfig
1471
- ): OperationResponse<Paths.GetMetersByContractId.Responses.$200>
1472
- /**
1473
- * getMeter - Get Meter
1474
- *
1475
- * Retrieves the details of a meter.
1476
- */
1477
- 'getMeter'(
1478
- parameters?: Parameters<Paths.GetMeter.PathParameters> | null,
1479
- data?: any,
1480
- config?: AxiosRequestConfig
1481
- ): OperationResponse<Paths.GetMeter.Responses.$200>
1482
- /**
1483
- * updateMeter - Update Meter
1484
- *
1485
- * Updates the details of a meter.
1486
- */
1487
- 'updateMeter'(
1488
- parameters?: Parameters<Paths.UpdateMeter.PathParameters> | null,
1489
- data?: Paths.UpdateMeter.RequestBody,
1490
- config?: AxiosRequestConfig
1491
- ): OperationResponse<Paths.UpdateMeter.Responses.$200>
1492
- /**
1493
- * getMeterCounters - Get Meter Counters
1494
- *
1495
- * Retrieves all counters for a given meter.
1496
- */
1497
- 'getMeterCounters'(
1498
- parameters?: Parameters<Paths.GetMeterCounters.QueryParameters> | null,
1499
- data?: any,
1500
- config?: AxiosRequestConfig
1501
- ): OperationResponse<Paths.GetMeterCounters.Responses.$200>
1502
- /**
1503
- * getCounterDetails - Get Counter Details
1504
- *
1505
- * Retrieves the details of a meter counter.
1506
- */
1507
- 'getCounterDetails'(
1508
- parameters?: Parameters<Paths.GetCounterDetails.PathParameters> | null,
1509
- data?: any,
1510
- config?: AxiosRequestConfig
1511
- ): OperationResponse<Paths.GetCounterDetails.Responses.$200>
1512
- /**
1513
- * createMeterReading - Create Meter Reading
1514
- *
1515
- * Inserts a new meter reading.
1516
- */
1517
- 'createMeterReading'(
1518
- parameters?: Parameters<UnknownParamsObject> | null,
1519
- data?: Paths.CreateMeterReading.RequestBody,
1520
- config?: AxiosRequestConfig
1521
- ): OperationResponse<Paths.CreateMeterReading.Responses.$200>
1522
- /**
1523
- * createMeterReadings - Create Meter Readings
1524
- *
1525
- * Inserts multiple meter readings at once. Limited to 100 readings per request.
1526
- */
1527
- 'createMeterReadings'(
1528
- parameters?: Parameters<Paths.CreateMeterReadings.QueryParameters> | null,
1529
- data?: Paths.CreateMeterReadings.RequestBody,
1530
- config?: AxiosRequestConfig
1531
- ): OperationResponse<Paths.CreateMeterReadings.Responses.$200>
1532
- /**
1533
- * createPortalMeterReadings - createPortalMeterReadings
1534
- *
1535
- * Inserts multiple meter readings at once for a given meter. Limited to 2 readings per request.
1536
- */
1537
- 'createPortalMeterReadings'(
1538
- parameters?: Parameters<Paths.CreatePortalMeterReadings.PathParameters> | null,
1539
- data?: Paths.CreatePortalMeterReadings.RequestBody,
1540
- config?: AxiosRequestConfig
1541
- ): OperationResponse<Paths.CreatePortalMeterReadings.Responses.$200>
1542
- /**
1543
- * batchWriteMeterReadings - Batch Write Readings
1544
- *
1545
- * Upserts/Deletes multiple meter readings at once. Limited to 100 readings per request.
1546
- */
1547
- 'batchWriteMeterReadings'(
1548
- parameters?: Parameters<Paths.BatchWriteMeterReadings.QueryParameters> | null,
1549
- data?: Paths.BatchWriteMeterReadings.RequestBody,
1550
- config?: AxiosRequestConfig
1551
- ): OperationResponse<Paths.BatchWriteMeterReadings.Responses.$200>
1552
- /**
1553
- * createMeterReadingFromSubmission - Create Meter Reading from Submission
1554
- *
1555
- * Creates a reading from a journey submission.
1556
- */
1557
- 'createMeterReadingFromSubmission'(
1558
- parameters?: Parameters<UnknownParamsObject> | null,
1559
- data?: Paths.CreateMeterReadingFromSubmission.RequestBody,
1560
- config?: AxiosRequestConfig
1561
- ): OperationResponse<Paths.CreateMeterReadingFromSubmission.Responses.$200>
1562
- /**
1563
- * getAllowedReadingForMeter - getAllowedReadingForMeter
1564
- *
1565
- * Get allowed reading for the given meter
1566
- */
1567
- 'getAllowedReadingForMeter'(
1568
- parameters?: Parameters<Paths.GetAllowedReadingForMeter.QueryParameters & Paths.GetAllowedReadingForMeter.PathParameters> | null,
1569
- data?: any,
1570
- config?: AxiosRequestConfig
1571
- ): OperationResponse<Paths.GetAllowedReadingForMeter.Responses.$200>
1572
- /**
1573
- * createReadingWithMeter - Create Reading with Meter
1574
- *
1575
- * Creates a reading along with a meter.
1576
- */
1577
- 'createReadingWithMeter'(
1578
- parameters?: Parameters<UnknownParamsObject> | null,
1579
- data?: Paths.CreateReadingWithMeter.RequestBody,
1580
- config?: AxiosRequestConfig
1581
- ): OperationResponse<Paths.CreateReadingWithMeter.Responses.$200>
1582
- /**
1583
- * getReadingsByInterval - Get Readings by Interval
1584
- *
1585
- * Retrieves all readings specified in an interval.
1586
- * If the start_date and end_date are equal, then it returns the readings of the specified date.
1587
- * The start_date should be less than or equal to the end_date.
1588
- *
1589
- */
1590
- 'getReadingsByInterval'(
1591
- parameters?: Parameters<Paths.GetReadingsByInterval.QueryParameters & Paths.GetReadingsByInterval.PathParameters> | null,
1592
- data?: any,
1593
- config?: AxiosRequestConfig
1594
- ): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
1595
- /**
1596
- * updateMeterReading - Update Meter Reading
1597
- *
1598
- * Updates a meter reading.
1599
- */
1600
- 'updateMeterReading'(
1601
- parameters?: Parameters<Paths.UpdateMeterReading.QueryParameters & Paths.UpdateMeterReading.PathParameters> | null,
1602
- data?: Paths.UpdateMeterReading.RequestBody,
1603
- config?: AxiosRequestConfig
1604
- ): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
1605
- /**
1606
- * deleteMeterReading - Delete Meter Reading
1607
- *
1608
- * Deletes a meter reading.
1609
- */
1610
- 'deleteMeterReading'(
1611
- parameters?: Parameters<Paths.DeleteMeterReading.QueryParameters & Paths.DeleteMeterReading.PathParameters> | null,
1612
- data?: any,
1613
- config?: AxiosRequestConfig
1614
- ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
1615
- }
1616
-
1617
- interface PathsDictionary {
1618
- ['/v1/metering/meter']: {
1619
- /**
1620
- * getCustomerMeters - Get Customer Meters
1621
- *
1622
- * Retrieves all meters related to a customer.
1623
- */
1624
- 'get'(
1625
- parameters?: Parameters<UnknownParamsObject> | null,
1626
- data?: any,
1627
- config?: AxiosRequestConfig
1628
- ): OperationResponse<Paths.GetCustomerMeters.Responses.$200>
1629
- }
1630
- ['/v1/metering/contract/meters/{contract_id}']: {
1631
- /**
1632
- * getMetersByContractId - getMetersByContractId
1633
- *
1634
- * Retrieves all meters related to a contract.
1635
- */
1636
- 'get'(
1637
- parameters?: Parameters<Paths.GetMetersByContractId.PathParameters> | null,
1638
- data?: any,
1639
- config?: AxiosRequestConfig
1640
- ): OperationResponse<Paths.GetMetersByContractId.Responses.$200>
1641
- }
1642
- ['/v1/metering/meter/{id}']: {
1643
- /**
1644
- * updateMeter - Update Meter
1645
- *
1646
- * Updates the details of a meter.
1647
- */
1648
- 'patch'(
1649
- parameters?: Parameters<Paths.UpdateMeter.PathParameters> | null,
1650
- data?: Paths.UpdateMeter.RequestBody,
1651
- config?: AxiosRequestConfig
1652
- ): OperationResponse<Paths.UpdateMeter.Responses.$200>
1653
- /**
1654
- * getMeter - Get Meter
1655
- *
1656
- * Retrieves the details of a meter.
1657
- */
1658
- 'get'(
1659
- parameters?: Parameters<Paths.GetMeter.PathParameters> | null,
1660
- data?: any,
1661
- config?: AxiosRequestConfig
1662
- ): OperationResponse<Paths.GetMeter.Responses.$200>
1663
- }
1664
- ['/v1/metering/counter']: {
1665
- /**
1666
- * getMeterCounters - Get Meter Counters
1667
- *
1668
- * Retrieves all counters for a given meter.
1669
- */
1670
- 'get'(
1671
- parameters?: Parameters<Paths.GetMeterCounters.QueryParameters> | null,
1672
- data?: any,
1673
- config?: AxiosRequestConfig
1674
- ): OperationResponse<Paths.GetMeterCounters.Responses.$200>
1675
- }
1676
- ['/v1/metering/counter/{counter_id}']: {
1677
- /**
1678
- * getCounterDetails - Get Counter Details
1679
- *
1680
- * Retrieves the details of a meter counter.
1681
- */
1682
- 'get'(
1683
- parameters?: Parameters<Paths.GetCounterDetails.PathParameters> | null,
1684
- data?: any,
1685
- config?: AxiosRequestConfig
1686
- ): OperationResponse<Paths.GetCounterDetails.Responses.$200>
1687
- }
1688
- ['/v1/metering/reading']: {
1689
- /**
1690
- * createMeterReading - Create Meter Reading
1691
- *
1692
- * Inserts a new meter reading.
1693
- */
1694
- 'post'(
1695
- parameters?: Parameters<UnknownParamsObject> | null,
1696
- data?: Paths.CreateMeterReading.RequestBody,
1697
- config?: AxiosRequestConfig
1698
- ): OperationResponse<Paths.CreateMeterReading.Responses.$200>
1699
- }
1700
- ['/v1/metering/readings']: {
1701
- /**
1702
- * createMeterReadings - Create Meter Readings
1703
- *
1704
- * Inserts multiple meter readings at once. Limited to 100 readings per request.
1705
- */
1706
- 'post'(
1707
- parameters?: Parameters<Paths.CreateMeterReadings.QueryParameters> | null,
1708
- data?: Paths.CreateMeterReadings.RequestBody,
1709
- config?: AxiosRequestConfig
1710
- ): OperationResponse<Paths.CreateMeterReadings.Responses.$200>
1711
- }
1712
- ['/v1/metering/readings/{meter_id}']: {
1713
- /**
1714
- * createPortalMeterReadings - createPortalMeterReadings
1715
- *
1716
- * Inserts multiple meter readings at once for a given meter. Limited to 2 readings per request.
1717
- */
1718
- 'post'(
1719
- parameters?: Parameters<Paths.CreatePortalMeterReadings.PathParameters> | null,
1720
- data?: Paths.CreatePortalMeterReadings.RequestBody,
1721
- config?: AxiosRequestConfig
1722
- ): OperationResponse<Paths.CreatePortalMeterReadings.Responses.$200>
1723
- }
1724
- ['/v2/metering/readings']: {
1725
- /**
1726
- * batchWriteMeterReadings - Batch Write Readings
1727
- *
1728
- * Upserts/Deletes multiple meter readings at once. Limited to 100 readings per request.
1729
- */
1730
- 'post'(
1731
- parameters?: Parameters<Paths.BatchWriteMeterReadings.QueryParameters> | null,
1732
- data?: Paths.BatchWriteMeterReadings.RequestBody,
1733
- config?: AxiosRequestConfig
1734
- ): OperationResponse<Paths.BatchWriteMeterReadings.Responses.$200>
1735
- }
1736
- ['/v1/metering/reading/submission']: {
1737
- /**
1738
- * createMeterReadingFromSubmission - Create Meter Reading from Submission
1739
- *
1740
- * Creates a reading from a journey submission.
1741
- */
1742
- 'post'(
1743
- parameters?: Parameters<UnknownParamsObject> | null,
1744
- data?: Paths.CreateMeterReadingFromSubmission.RequestBody,
1745
- config?: AxiosRequestConfig
1746
- ): OperationResponse<Paths.CreateMeterReadingFromSubmission.Responses.$200>
1747
- }
1748
- ['/v1/metering/allowed/reading/{meter_id}']: {
1749
- /**
1750
- * getAllowedReadingForMeter - getAllowedReadingForMeter
1751
- *
1752
- * Get allowed reading for the given meter
1753
- */
1754
- 'get'(
1755
- parameters?: Parameters<Paths.GetAllowedReadingForMeter.QueryParameters & Paths.GetAllowedReadingForMeter.PathParameters> | null,
1756
- data?: any,
1757
- config?: AxiosRequestConfig
1758
- ): OperationResponse<Paths.GetAllowedReadingForMeter.Responses.$200>
1759
- }
1760
- ['/v1/metering/reading/with-meter']: {
1761
- /**
1762
- * createReadingWithMeter - Create Reading with Meter
1763
- *
1764
- * Creates a reading along with a meter.
1765
- */
1766
- 'post'(
1767
- parameters?: Parameters<UnknownParamsObject> | null,
1768
- data?: Paths.CreateReadingWithMeter.RequestBody,
1769
- config?: AxiosRequestConfig
1770
- ): OperationResponse<Paths.CreateReadingWithMeter.Responses.$200>
1771
- }
1772
- ['/v1/metering/reading/{meter_id}/{counter_id}']: {
1773
- /**
1774
- * getReadingsByInterval - Get Readings by Interval
1775
- *
1776
- * Retrieves all readings specified in an interval.
1777
- * If the start_date and end_date are equal, then it returns the readings of the specified date.
1778
- * The start_date should be less than or equal to the end_date.
1779
- *
1780
- */
1781
- 'get'(
1782
- parameters?: Parameters<Paths.GetReadingsByInterval.QueryParameters & Paths.GetReadingsByInterval.PathParameters> | null,
1783
- data?: any,
1784
- config?: AxiosRequestConfig
1785
- ): OperationResponse<Paths.GetReadingsByInterval.Responses.$200>
1786
- /**
1787
- * updateMeterReading - Update Meter Reading
1788
- *
1789
- * Updates a meter reading.
1790
- */
1791
- 'put'(
1792
- parameters?: Parameters<Paths.UpdateMeterReading.QueryParameters & Paths.UpdateMeterReading.PathParameters> | null,
1793
- data?: Paths.UpdateMeterReading.RequestBody,
1794
- config?: AxiosRequestConfig
1795
- ): OperationResponse<Paths.UpdateMeterReading.Responses.$200>
1796
- /**
1797
- * deleteMeterReading - Delete Meter Reading
1798
- *
1799
- * Deletes a meter reading.
1800
- */
1801
- 'delete'(
1802
- parameters?: Parameters<Paths.DeleteMeterReading.QueryParameters & Paths.DeleteMeterReading.PathParameters> | null,
1803
- data?: any,
1804
- config?: AxiosRequestConfig
1805
- ): OperationResponse<Paths.DeleteMeterReading.Responses.$200>
1806
- }
1807
- }
1808
-
1809
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1810
-
1811
- type ActionLabel = Components.Schemas.ActionLabel;
1812
- type ActivityId = Components.Schemas.ActivityId;
1813
- type BaseEntity = Components.Schemas.BaseEntity;
1814
- type CounterReadingOnSubmission = Components.Schemas.CounterReadingOnSubmission;
1815
- type Direction = Components.Schemas.Direction;
1816
- type Entity = Components.Schemas.Entity;
1817
- type EntityId = Components.Schemas.EntityId;
1818
- type EntityItem = Components.Schemas.EntityItem;
1819
- type EntityRelation = Components.Schemas.EntityRelation;
1820
- type EntitySlug = Components.Schemas.EntitySlug;
1821
- type ErrorResp = Components.Schemas.ErrorResp;
1822
- type Id = Components.Schemas.Id;
1823
- type JourneyActions = Components.Schemas.JourneyActions;
1824
- type Meter = Components.Schemas.Meter;
1825
- type MeterCounter = Components.Schemas.MeterCounter;
1826
- type MeterReading = Components.Schemas.MeterReading;
1827
- type PortalMeterReading = Components.Schemas.PortalMeterReading;
1828
- type ReadBy = Components.Schemas.ReadBy;
1829
- type Reading = Components.Schemas.Reading;
1830
- type ReadingStatus = Components.Schemas.ReadingStatus;
1831
- type ReadingWithMeter = Components.Schemas.ReadingWithMeter;
1832
- type Reason = Components.Schemas.Reason;
1833
- type ReasonString = Components.Schemas.ReasonString;
1834
- type Rule = Components.Schemas.Rule;
1835
- type Source = Components.Schemas.Source;
1836
- type SubmissionMeterReading = Components.Schemas.SubmissionMeterReading;
1837
- type TariffType = Components.Schemas.TariffType;
1838
- type Unit = Components.Schemas.Unit;
1839
- type UpdateMeterReading = Components.Schemas.UpdateMeterReading;
1840
-
1841
- export { type ActionLabel as A, type BaseEntity as B, type Client as C, type Direction as D, type Entity as E, type Id as I, type JourneyActions as J, type Meter as M, type OperationMethods as O, Paths as P, type ReadBy as R, type Source as S, type TariffType as T, type Unit as U, Components as a, type PathsDictionary as b, type ActivityId as c, type CounterReadingOnSubmission as d, type EntityId as e, type EntityItem as f, type EntityRelation as g, type EntitySlug as h, type ErrorResp as i, type MeterCounter as j, type MeterReading as k, type PortalMeterReading as l, type Reading as m, type ReadingStatus as n, type ReadingWithMeter as o, type Reason as p, type ReasonString as q, type Rule as r, type SubmissionMeterReading as s, UpdateMeterReading as t };