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