@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,994 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/* Auto-copied from billing-client */
|
|
5
|
+
/* eslint-disable */
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
declare namespace Components {
|
|
10
|
+
namespace Schemas {
|
|
11
|
+
export interface Balance {
|
|
12
|
+
/**
|
|
13
|
+
* Current balance of the customer in cents. (precision 2)
|
|
14
|
+
* example:
|
|
15
|
+
* 8990
|
|
16
|
+
*/
|
|
17
|
+
balance?: number;
|
|
18
|
+
/**
|
|
19
|
+
* Current balance of the customer in decimal string representation.
|
|
20
|
+
* example:
|
|
21
|
+
* 89.90
|
|
22
|
+
*/
|
|
23
|
+
balance_decimal?: string;
|
|
24
|
+
balance_currency?: /**
|
|
25
|
+
* Currency code in ISO 4217 format
|
|
26
|
+
* example:
|
|
27
|
+
* EUR
|
|
28
|
+
*/
|
|
29
|
+
Currency;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* A base billing event to be inherited by all billing events.
|
|
33
|
+
*/
|
|
34
|
+
export interface BaseBillingEvent {
|
|
35
|
+
[name: string]: any;
|
|
36
|
+
_id?: /**
|
|
37
|
+
* Entity ID
|
|
38
|
+
* example:
|
|
39
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
40
|
+
*/
|
|
41
|
+
EntityId;
|
|
42
|
+
/**
|
|
43
|
+
* Title of entity
|
|
44
|
+
*/
|
|
45
|
+
_title?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Organization Id the entity belongs to
|
|
48
|
+
*/
|
|
49
|
+
_org?: string;
|
|
50
|
+
_schema?: /**
|
|
51
|
+
* URL-friendly identifier for the entity schema
|
|
52
|
+
* example:
|
|
53
|
+
* contact
|
|
54
|
+
*/
|
|
55
|
+
EntitySlug;
|
|
56
|
+
_tags?: string[];
|
|
57
|
+
_created_at?: string;
|
|
58
|
+
_updated_at?: string;
|
|
59
|
+
/**
|
|
60
|
+
* Amount to be paid in cents i.e. precision 2
|
|
61
|
+
* example:
|
|
62
|
+
* 10050
|
|
63
|
+
*/
|
|
64
|
+
billing_amount: number;
|
|
65
|
+
/**
|
|
66
|
+
* Amount to be paid in cents in decimal string representation
|
|
67
|
+
* example:
|
|
68
|
+
* 100.50
|
|
69
|
+
*/
|
|
70
|
+
billing_amount_decimal: string;
|
|
71
|
+
billing_currency: /**
|
|
72
|
+
* Currency code in ISO 4217 format
|
|
73
|
+
* example:
|
|
74
|
+
* EUR
|
|
75
|
+
*/
|
|
76
|
+
Currency;
|
|
77
|
+
/**
|
|
78
|
+
* Unique identifier for event, used to reference the event to a 3rd party resource such as a SAP Installment.
|
|
79
|
+
* example:
|
|
80
|
+
* d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e
|
|
81
|
+
*/
|
|
82
|
+
external_id?: string;
|
|
83
|
+
contract: {
|
|
84
|
+
$relation?: EntityRelationItem[];
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
export interface BaseEntity {
|
|
88
|
+
[name: string]: any;
|
|
89
|
+
_id?: /**
|
|
90
|
+
* Entity ID
|
|
91
|
+
* example:
|
|
92
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
93
|
+
*/
|
|
94
|
+
EntityId;
|
|
95
|
+
/**
|
|
96
|
+
* Title of entity
|
|
97
|
+
*/
|
|
98
|
+
_title?: string;
|
|
99
|
+
/**
|
|
100
|
+
* Organization Id the entity belongs to
|
|
101
|
+
*/
|
|
102
|
+
_org?: string;
|
|
103
|
+
_schema?: /**
|
|
104
|
+
* URL-friendly identifier for the entity schema
|
|
105
|
+
* example:
|
|
106
|
+
* contact
|
|
107
|
+
*/
|
|
108
|
+
EntitySlug;
|
|
109
|
+
_tags?: string[];
|
|
110
|
+
_created_at?: string;
|
|
111
|
+
_updated_at?: string;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* An entity that describes a billing event such as a future installment or a reimbursement back to the customer.
|
|
115
|
+
*/
|
|
116
|
+
export type BillingEvent = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ /* An entity that describes an installment billing event. */ InstallmentEvent | /* An entity that describes a reimbursement billing event. */ ReimbursementEvent;
|
|
117
|
+
export interface Contract {
|
|
118
|
+
[name: string]: any;
|
|
119
|
+
_id?: /**
|
|
120
|
+
* Entity ID
|
|
121
|
+
* example:
|
|
122
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
123
|
+
*/
|
|
124
|
+
EntityId;
|
|
125
|
+
/**
|
|
126
|
+
* Title of entity
|
|
127
|
+
*/
|
|
128
|
+
_title?: string;
|
|
129
|
+
/**
|
|
130
|
+
* Organization Id the entity belongs to
|
|
131
|
+
*/
|
|
132
|
+
_org?: string;
|
|
133
|
+
_schema?: /**
|
|
134
|
+
* URL-friendly identifier for the entity schema
|
|
135
|
+
* example:
|
|
136
|
+
* contact
|
|
137
|
+
*/
|
|
138
|
+
EntitySlug;
|
|
139
|
+
_tags?: string[];
|
|
140
|
+
_created_at?: string;
|
|
141
|
+
_updated_at?: string;
|
|
142
|
+
/**
|
|
143
|
+
* The name of the contract.
|
|
144
|
+
* example:
|
|
145
|
+
* Grid Contract
|
|
146
|
+
*/
|
|
147
|
+
contract_name?: string;
|
|
148
|
+
/**
|
|
149
|
+
* The unique identifier of the contract.
|
|
150
|
+
* example:
|
|
151
|
+
* 12345
|
|
152
|
+
*/
|
|
153
|
+
contract_number?: string;
|
|
154
|
+
/**
|
|
155
|
+
* The status of the contract.
|
|
156
|
+
* example:
|
|
157
|
+
* approved
|
|
158
|
+
*/
|
|
159
|
+
status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired";
|
|
160
|
+
/**
|
|
161
|
+
* A brief description of the contract.
|
|
162
|
+
* example:
|
|
163
|
+
* This contract is for the supply of widgets.
|
|
164
|
+
*/
|
|
165
|
+
description?: string;
|
|
166
|
+
/**
|
|
167
|
+
* The account number associated with the contract.
|
|
168
|
+
* example:
|
|
169
|
+
* 67890
|
|
170
|
+
*/
|
|
171
|
+
account_number?: string;
|
|
172
|
+
/**
|
|
173
|
+
* The branch associated with the contract.
|
|
174
|
+
* example:
|
|
175
|
+
* power
|
|
176
|
+
*/
|
|
177
|
+
branch?: "power" | "gas" | "water" | "waste_water" | "district_heating";
|
|
178
|
+
/**
|
|
179
|
+
* The billing address associated with the contract.
|
|
180
|
+
* example:
|
|
181
|
+
* 123 Main St, Anytown
|
|
182
|
+
*/
|
|
183
|
+
billing_address?: string;
|
|
184
|
+
/**
|
|
185
|
+
* The delivery address associated with the contract.
|
|
186
|
+
* example:
|
|
187
|
+
* 456 Elm St, Anytown
|
|
188
|
+
*/
|
|
189
|
+
delivery_address?: string;
|
|
190
|
+
/**
|
|
191
|
+
* Any additional addresses associated with the contract.
|
|
192
|
+
* example:
|
|
193
|
+
* 789 Oak St, Anytown
|
|
194
|
+
*/
|
|
195
|
+
additional_addresses?: string;
|
|
196
|
+
/**
|
|
197
|
+
* The date on which the contract was terminated.
|
|
198
|
+
* example:
|
|
199
|
+
* 2022-01-01
|
|
200
|
+
*/
|
|
201
|
+
termination_date?: string;
|
|
202
|
+
/**
|
|
203
|
+
* The reason for the termination of the contract.
|
|
204
|
+
* example:
|
|
205
|
+
* Non-payment
|
|
206
|
+
*/
|
|
207
|
+
termination_reason?: string;
|
|
208
|
+
/**
|
|
209
|
+
* The billing period associated with the contract.
|
|
210
|
+
* example:
|
|
211
|
+
* monthly
|
|
212
|
+
*/
|
|
213
|
+
billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
|
|
214
|
+
/**
|
|
215
|
+
* The duration of the billing period.
|
|
216
|
+
* example:
|
|
217
|
+
* 30
|
|
218
|
+
*/
|
|
219
|
+
billing_duration_amount?: number;
|
|
220
|
+
/**
|
|
221
|
+
* The duration of the renewal period.
|
|
222
|
+
* example:
|
|
223
|
+
* 365
|
|
224
|
+
*/
|
|
225
|
+
renewal_duration_amount?: number;
|
|
226
|
+
/**
|
|
227
|
+
* The unit of time for the renewal period.
|
|
228
|
+
* example:
|
|
229
|
+
* years
|
|
230
|
+
*/
|
|
231
|
+
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
232
|
+
/**
|
|
233
|
+
* The amount of notice required for termination of the contract.
|
|
234
|
+
* example:
|
|
235
|
+
* 30
|
|
236
|
+
*/
|
|
237
|
+
notice_time_amount?: number;
|
|
238
|
+
/**
|
|
239
|
+
* The unit of time for the notice period.
|
|
240
|
+
* example:
|
|
241
|
+
* months
|
|
242
|
+
*/
|
|
243
|
+
notice_time_unit?: "weeks" | "months" | "years";
|
|
244
|
+
/**
|
|
245
|
+
* The start date of the contract.
|
|
246
|
+
* example:
|
|
247
|
+
* 2021-01-01
|
|
248
|
+
*/
|
|
249
|
+
start_date?: string;
|
|
250
|
+
/**
|
|
251
|
+
* Defines the day of the month in which the installments are due.
|
|
252
|
+
* example:
|
|
253
|
+
* 2
|
|
254
|
+
*/
|
|
255
|
+
billing_due_day?: number;
|
|
256
|
+
/**
|
|
257
|
+
* Set amount for installments in cents. (precision 2)
|
|
258
|
+
* example:
|
|
259
|
+
* 10050
|
|
260
|
+
*/
|
|
261
|
+
installment_amount?: number;
|
|
262
|
+
/**
|
|
263
|
+
* Current balance of the contract in cents. (precision 2)
|
|
264
|
+
* example:
|
|
265
|
+
* 8990
|
|
266
|
+
*/
|
|
267
|
+
balance?: number;
|
|
268
|
+
balance_currency?: /**
|
|
269
|
+
* Currency code in ISO 4217 format
|
|
270
|
+
* example:
|
|
271
|
+
* EUR
|
|
272
|
+
*/
|
|
273
|
+
Currency;
|
|
274
|
+
}
|
|
275
|
+
export interface ContractItem {
|
|
276
|
+
[name: string]: any;
|
|
277
|
+
_id: /**
|
|
278
|
+
* Entity ID
|
|
279
|
+
* example:
|
|
280
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
281
|
+
*/
|
|
282
|
+
EntityId;
|
|
283
|
+
/**
|
|
284
|
+
* Title of entity
|
|
285
|
+
*/
|
|
286
|
+
_title: string;
|
|
287
|
+
/**
|
|
288
|
+
* Organization Id the entity belongs to
|
|
289
|
+
*/
|
|
290
|
+
_org: string;
|
|
291
|
+
_schema?: /**
|
|
292
|
+
* URL-friendly identifier for the entity schema
|
|
293
|
+
* example:
|
|
294
|
+
* contact
|
|
295
|
+
*/
|
|
296
|
+
EntitySlug;
|
|
297
|
+
_tags?: string[];
|
|
298
|
+
_created_at: string;
|
|
299
|
+
_updated_at: string;
|
|
300
|
+
/**
|
|
301
|
+
* The name of the contract.
|
|
302
|
+
* example:
|
|
303
|
+
* Grid Contract
|
|
304
|
+
*/
|
|
305
|
+
contract_name?: string;
|
|
306
|
+
/**
|
|
307
|
+
* The unique identifier of the contract.
|
|
308
|
+
* example:
|
|
309
|
+
* 12345
|
|
310
|
+
*/
|
|
311
|
+
contract_number?: string;
|
|
312
|
+
/**
|
|
313
|
+
* The status of the contract.
|
|
314
|
+
* example:
|
|
315
|
+
* approved
|
|
316
|
+
*/
|
|
317
|
+
status?: "draft" | "in_approval_process" | "approved" | "active" | "deactivated" | "revoked" | "terminated" | "expired";
|
|
318
|
+
/**
|
|
319
|
+
* A brief description of the contract.
|
|
320
|
+
* example:
|
|
321
|
+
* This contract is for the supply of widgets.
|
|
322
|
+
*/
|
|
323
|
+
description?: string;
|
|
324
|
+
/**
|
|
325
|
+
* The account number associated with the contract.
|
|
326
|
+
* example:
|
|
327
|
+
* 67890
|
|
328
|
+
*/
|
|
329
|
+
account_number?: string;
|
|
330
|
+
/**
|
|
331
|
+
* The branch associated with the contract.
|
|
332
|
+
* example:
|
|
333
|
+
* power
|
|
334
|
+
*/
|
|
335
|
+
branch?: "power" | "gas" | "water" | "waste_water" | "district_heating";
|
|
336
|
+
/**
|
|
337
|
+
* The billing address associated with the contract.
|
|
338
|
+
* example:
|
|
339
|
+
* 123 Main St, Anytown
|
|
340
|
+
*/
|
|
341
|
+
billing_address?: string;
|
|
342
|
+
/**
|
|
343
|
+
* The delivery address associated with the contract.
|
|
344
|
+
* example:
|
|
345
|
+
* 456 Elm St, Anytown
|
|
346
|
+
*/
|
|
347
|
+
delivery_address?: string;
|
|
348
|
+
/**
|
|
349
|
+
* Any additional addresses associated with the contract.
|
|
350
|
+
* example:
|
|
351
|
+
* 789 Oak St, Anytown
|
|
352
|
+
*/
|
|
353
|
+
additional_addresses?: string;
|
|
354
|
+
/**
|
|
355
|
+
* The date on which the contract was terminated.
|
|
356
|
+
* example:
|
|
357
|
+
* 2022-01-01
|
|
358
|
+
*/
|
|
359
|
+
termination_date?: string;
|
|
360
|
+
/**
|
|
361
|
+
* The reason for the termination of the contract.
|
|
362
|
+
* example:
|
|
363
|
+
* Non-payment
|
|
364
|
+
*/
|
|
365
|
+
termination_reason?: string;
|
|
366
|
+
/**
|
|
367
|
+
* The billing period associated with the contract.
|
|
368
|
+
* example:
|
|
369
|
+
* monthly
|
|
370
|
+
*/
|
|
371
|
+
billing_period?: "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly";
|
|
372
|
+
/**
|
|
373
|
+
* The duration of the billing period.
|
|
374
|
+
* example:
|
|
375
|
+
* 30
|
|
376
|
+
*/
|
|
377
|
+
billing_duration_amount?: number;
|
|
378
|
+
/**
|
|
379
|
+
* The duration of the renewal period.
|
|
380
|
+
* example:
|
|
381
|
+
* 365
|
|
382
|
+
*/
|
|
383
|
+
renewal_duration_amount?: number;
|
|
384
|
+
/**
|
|
385
|
+
* The unit of time for the renewal period.
|
|
386
|
+
* example:
|
|
387
|
+
* years
|
|
388
|
+
*/
|
|
389
|
+
renewal_duration_unit?: "weeks" | "months" | "years";
|
|
390
|
+
/**
|
|
391
|
+
* The amount of notice required for termination of the contract.
|
|
392
|
+
* example:
|
|
393
|
+
* 30
|
|
394
|
+
*/
|
|
395
|
+
notice_time_amount?: number;
|
|
396
|
+
/**
|
|
397
|
+
* The unit of time for the notice period.
|
|
398
|
+
* example:
|
|
399
|
+
* months
|
|
400
|
+
*/
|
|
401
|
+
notice_time_unit?: "weeks" | "months" | "years";
|
|
402
|
+
/**
|
|
403
|
+
* The start date of the contract.
|
|
404
|
+
* example:
|
|
405
|
+
* 2021-01-01
|
|
406
|
+
*/
|
|
407
|
+
start_date?: string;
|
|
408
|
+
/**
|
|
409
|
+
* Defines the day of the month in which the installments are due.
|
|
410
|
+
* example:
|
|
411
|
+
* 2
|
|
412
|
+
*/
|
|
413
|
+
billing_due_day?: number;
|
|
414
|
+
/**
|
|
415
|
+
* Set amount for installments in cents. (precision 2)
|
|
416
|
+
* example:
|
|
417
|
+
* 10050
|
|
418
|
+
*/
|
|
419
|
+
installment_amount?: number;
|
|
420
|
+
/**
|
|
421
|
+
* Current balance of the contract in cents. (precision 2)
|
|
422
|
+
* example:
|
|
423
|
+
* 8990
|
|
424
|
+
*/
|
|
425
|
+
balance?: number;
|
|
426
|
+
balance_currency?: /**
|
|
427
|
+
* Currency code in ISO 4217 format
|
|
428
|
+
* example:
|
|
429
|
+
* EUR
|
|
430
|
+
*/
|
|
431
|
+
Currency;
|
|
432
|
+
}
|
|
433
|
+
/**
|
|
434
|
+
* Currency code in ISO 4217 format
|
|
435
|
+
* example:
|
|
436
|
+
* EUR
|
|
437
|
+
*/
|
|
438
|
+
export type Currency = string;
|
|
439
|
+
/**
|
|
440
|
+
* Entity ID
|
|
441
|
+
* example:
|
|
442
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
443
|
+
*/
|
|
444
|
+
export type EntityId = string;
|
|
445
|
+
export interface EntityRelationItem {
|
|
446
|
+
/**
|
|
447
|
+
* Entity ID for the related contract.
|
|
448
|
+
* example:
|
|
449
|
+
* f589786b-3024-43cd-9cb3-5a3c953f2896
|
|
450
|
+
*/
|
|
451
|
+
entity_id?: string;
|
|
452
|
+
}
|
|
453
|
+
/**
|
|
454
|
+
* URL-friendly identifier for the entity schema
|
|
455
|
+
* example:
|
|
456
|
+
* contact
|
|
457
|
+
*/
|
|
458
|
+
export type EntitySlug = "contact" | "contract" | "file" | "order" | "opportunity" | "product" | "price" | "meter" | "meter_counter" | "billing_event";
|
|
459
|
+
/**
|
|
460
|
+
* An entity that describes an installment billing event.
|
|
461
|
+
*/
|
|
462
|
+
export interface InstallmentEvent {
|
|
463
|
+
[name: string]: any;
|
|
464
|
+
_id?: /**
|
|
465
|
+
* Entity ID
|
|
466
|
+
* example:
|
|
467
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
468
|
+
*/
|
|
469
|
+
EntityId;
|
|
470
|
+
/**
|
|
471
|
+
* Title of entity
|
|
472
|
+
*/
|
|
473
|
+
_title?: string;
|
|
474
|
+
/**
|
|
475
|
+
* Organization Id the entity belongs to
|
|
476
|
+
*/
|
|
477
|
+
_org?: string;
|
|
478
|
+
_schema?: /**
|
|
479
|
+
* URL-friendly identifier for the entity schema
|
|
480
|
+
* example:
|
|
481
|
+
* contact
|
|
482
|
+
*/
|
|
483
|
+
EntitySlug;
|
|
484
|
+
_tags?: string[];
|
|
485
|
+
_created_at?: string;
|
|
486
|
+
_updated_at?: string;
|
|
487
|
+
/**
|
|
488
|
+
* Amount to be paid in cents i.e. precision 2
|
|
489
|
+
* example:
|
|
490
|
+
* 10050
|
|
491
|
+
*/
|
|
492
|
+
billing_amount: number;
|
|
493
|
+
/**
|
|
494
|
+
* Amount to be paid in cents in decimal string representation
|
|
495
|
+
* example:
|
|
496
|
+
* 100.50
|
|
497
|
+
*/
|
|
498
|
+
billing_amount_decimal: string;
|
|
499
|
+
billing_currency: /**
|
|
500
|
+
* Currency code in ISO 4217 format
|
|
501
|
+
* example:
|
|
502
|
+
* EUR
|
|
503
|
+
*/
|
|
504
|
+
Currency;
|
|
505
|
+
/**
|
|
506
|
+
* Unique identifier for event, used to reference the event to a 3rd party resource such as a SAP Installment.
|
|
507
|
+
* example:
|
|
508
|
+
* d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e
|
|
509
|
+
*/
|
|
510
|
+
external_id?: string;
|
|
511
|
+
contract: {
|
|
512
|
+
$relation?: EntityRelationItem[];
|
|
513
|
+
};
|
|
514
|
+
/**
|
|
515
|
+
* Type of the billing event.
|
|
516
|
+
* example:
|
|
517
|
+
* installment
|
|
518
|
+
*/
|
|
519
|
+
type: "installment";
|
|
520
|
+
/**
|
|
521
|
+
* Date on which the installment is due.
|
|
522
|
+
*/
|
|
523
|
+
due_date: string; // date-time
|
|
524
|
+
/**
|
|
525
|
+
* Date on which the installment is paid by the customer.
|
|
526
|
+
*/
|
|
527
|
+
paid_date?: string; // date-time
|
|
528
|
+
}
|
|
529
|
+
/**
|
|
530
|
+
* An entity that describes a reimbursement billing event.
|
|
531
|
+
*/
|
|
532
|
+
export interface ReimbursementEvent {
|
|
533
|
+
[name: string]: any;
|
|
534
|
+
_id?: /**
|
|
535
|
+
* Entity ID
|
|
536
|
+
* example:
|
|
537
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
538
|
+
*/
|
|
539
|
+
EntityId;
|
|
540
|
+
/**
|
|
541
|
+
* Title of entity
|
|
542
|
+
*/
|
|
543
|
+
_title?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Organization Id the entity belongs to
|
|
546
|
+
*/
|
|
547
|
+
_org?: string;
|
|
548
|
+
_schema?: /**
|
|
549
|
+
* URL-friendly identifier for the entity schema
|
|
550
|
+
* example:
|
|
551
|
+
* contact
|
|
552
|
+
*/
|
|
553
|
+
EntitySlug;
|
|
554
|
+
_tags?: string[];
|
|
555
|
+
_created_at?: string;
|
|
556
|
+
_updated_at?: string;
|
|
557
|
+
/**
|
|
558
|
+
* Amount to be paid in cents i.e. precision 2
|
|
559
|
+
* example:
|
|
560
|
+
* 10050
|
|
561
|
+
*/
|
|
562
|
+
billing_amount: number;
|
|
563
|
+
/**
|
|
564
|
+
* Amount to be paid in cents in decimal string representation
|
|
565
|
+
* example:
|
|
566
|
+
* 100.50
|
|
567
|
+
*/
|
|
568
|
+
billing_amount_decimal: string;
|
|
569
|
+
billing_currency: /**
|
|
570
|
+
* Currency code in ISO 4217 format
|
|
571
|
+
* example:
|
|
572
|
+
* EUR
|
|
573
|
+
*/
|
|
574
|
+
Currency;
|
|
575
|
+
/**
|
|
576
|
+
* Unique identifier for event, used to reference the event to a 3rd party resource such as a SAP Installment.
|
|
577
|
+
* example:
|
|
578
|
+
* d4fb2a4e-3f74-4fc4-8fba-6fdaaaa3b08e
|
|
579
|
+
*/
|
|
580
|
+
external_id?: string;
|
|
581
|
+
contract: {
|
|
582
|
+
$relation?: EntityRelationItem[];
|
|
583
|
+
};
|
|
584
|
+
/**
|
|
585
|
+
* Type of the billing event.
|
|
586
|
+
* example:
|
|
587
|
+
* reimbursement
|
|
588
|
+
*/
|
|
589
|
+
type: "reimbursement";
|
|
590
|
+
/**
|
|
591
|
+
* Date on which the customer is reimbursed.
|
|
592
|
+
*/
|
|
593
|
+
paid_date?: string; // date-time
|
|
594
|
+
}
|
|
595
|
+
}
|
|
596
|
+
}
|
|
597
|
+
declare namespace Paths {
|
|
598
|
+
namespace CreateBillingEvent {
|
|
599
|
+
/**
|
|
600
|
+
* An entity that describes a billing event such as a future installment or a reimbursement back to the customer.
|
|
601
|
+
*/
|
|
602
|
+
export type RequestBody = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ /* An entity that describes an installment billing event. */ Components.Schemas.InstallmentEvent | /* An entity that describes a reimbursement billing event. */ Components.Schemas.ReimbursementEvent;
|
|
603
|
+
namespace Responses {
|
|
604
|
+
/**
|
|
605
|
+
* An entity that describes a billing event such as a future installment or a reimbursement back to the customer.
|
|
606
|
+
*/
|
|
607
|
+
export type $201 = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ /* An entity that describes an installment billing event. */ Components.Schemas.InstallmentEvent | /* An entity that describes a reimbursement billing event. */ Components.Schemas.ReimbursementEvent;
|
|
608
|
+
}
|
|
609
|
+
}
|
|
610
|
+
namespace CreateContractEntity {
|
|
611
|
+
export type RequestBody = Components.Schemas.Contract;
|
|
612
|
+
namespace Responses {
|
|
613
|
+
export type $201 = Components.Schemas.ContractItem;
|
|
614
|
+
}
|
|
615
|
+
}
|
|
616
|
+
namespace DeleteBillingEvent {
|
|
617
|
+
namespace Parameters {
|
|
618
|
+
export type Id = string;
|
|
619
|
+
}
|
|
620
|
+
export interface PathParameters {
|
|
621
|
+
id: Parameters.Id;
|
|
622
|
+
}
|
|
623
|
+
namespace Responses {
|
|
624
|
+
export interface $204 {
|
|
625
|
+
}
|
|
626
|
+
}
|
|
627
|
+
}
|
|
628
|
+
namespace DeleteContractEntity {
|
|
629
|
+
namespace Parameters {
|
|
630
|
+
export type Id = string;
|
|
631
|
+
}
|
|
632
|
+
export interface PathParameters {
|
|
633
|
+
id: Parameters.Id;
|
|
634
|
+
}
|
|
635
|
+
namespace Responses {
|
|
636
|
+
export type $204 = Components.Schemas.ContractItem;
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
namespace GetBillingEvent {
|
|
640
|
+
namespace Parameters {
|
|
641
|
+
export type Id = string;
|
|
642
|
+
}
|
|
643
|
+
export interface PathParameters {
|
|
644
|
+
id: Parameters.Id;
|
|
645
|
+
}
|
|
646
|
+
namespace Responses {
|
|
647
|
+
export type $200 = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent;
|
|
648
|
+
}
|
|
649
|
+
}
|
|
650
|
+
namespace GetBillingEventByExternalId {
|
|
651
|
+
namespace Parameters {
|
|
652
|
+
export type ExternalId = string;
|
|
653
|
+
}
|
|
654
|
+
export interface PathParameters {
|
|
655
|
+
external_id: Parameters.ExternalId;
|
|
656
|
+
}
|
|
657
|
+
namespace Responses {
|
|
658
|
+
export type $200 = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent;
|
|
659
|
+
}
|
|
660
|
+
}
|
|
661
|
+
namespace GetBillingEvents {
|
|
662
|
+
namespace Parameters {
|
|
663
|
+
/**
|
|
664
|
+
* List billing events after this date
|
|
665
|
+
*/
|
|
666
|
+
export type DateAfter = string; // date-time
|
|
667
|
+
/**
|
|
668
|
+
* List billing events before this date
|
|
669
|
+
*/
|
|
670
|
+
export type DateBefore = string; // date-time
|
|
671
|
+
export type EntityId = string[];
|
|
672
|
+
/**
|
|
673
|
+
* Type of billing event to filter by
|
|
674
|
+
*/
|
|
675
|
+
export type EventType = "installment" | "reimbursement";
|
|
676
|
+
/**
|
|
677
|
+
* Initial offset to set for the search results
|
|
678
|
+
* example:
|
|
679
|
+
* 0
|
|
680
|
+
*/
|
|
681
|
+
export type From = number;
|
|
682
|
+
/**
|
|
683
|
+
* Size of the search results
|
|
684
|
+
* example:
|
|
685
|
+
* 100
|
|
686
|
+
*/
|
|
687
|
+
export type Size = number;
|
|
688
|
+
}
|
|
689
|
+
export interface QueryParameters {
|
|
690
|
+
from?: /**
|
|
691
|
+
* Initial offset to set for the search results
|
|
692
|
+
* example:
|
|
693
|
+
* 0
|
|
694
|
+
*/
|
|
695
|
+
Parameters.From;
|
|
696
|
+
size?: /**
|
|
697
|
+
* Size of the search results
|
|
698
|
+
* example:
|
|
699
|
+
* 100
|
|
700
|
+
*/
|
|
701
|
+
Parameters.Size;
|
|
702
|
+
entity_id?: Parameters.EntityId;
|
|
703
|
+
event_type?: /* Type of billing event to filter by */ Parameters.EventType;
|
|
704
|
+
date_after?: /* List billing events after this date */ Parameters.DateAfter /* date-time */;
|
|
705
|
+
date_before?: /* List billing events before this date */ Parameters.DateBefore /* date-time */;
|
|
706
|
+
}
|
|
707
|
+
namespace Responses {
|
|
708
|
+
export interface $200 {
|
|
709
|
+
hits?: number;
|
|
710
|
+
results?: /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent[];
|
|
711
|
+
}
|
|
712
|
+
}
|
|
713
|
+
}
|
|
714
|
+
namespace GetCustomerBalance {
|
|
715
|
+
namespace Parameters {
|
|
716
|
+
/**
|
|
717
|
+
* example:
|
|
718
|
+
* 1e3f0d58-69d2-4dbb-9a43-3ee63d862e8e
|
|
719
|
+
*/
|
|
720
|
+
export type Id = string;
|
|
721
|
+
}
|
|
722
|
+
export interface PathParameters {
|
|
723
|
+
id: /**
|
|
724
|
+
* example:
|
|
725
|
+
* 1e3f0d58-69d2-4dbb-9a43-3ee63d862e8e
|
|
726
|
+
*/
|
|
727
|
+
Parameters.Id;
|
|
728
|
+
}
|
|
729
|
+
namespace Responses {
|
|
730
|
+
export type $200 = Components.Schemas.Balance;
|
|
731
|
+
}
|
|
732
|
+
}
|
|
733
|
+
namespace UpdateBillingEvent {
|
|
734
|
+
namespace Parameters {
|
|
735
|
+
export type Id = string;
|
|
736
|
+
}
|
|
737
|
+
export interface PathParameters {
|
|
738
|
+
id: Parameters.Id;
|
|
739
|
+
}
|
|
740
|
+
export type RequestBody = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent;
|
|
741
|
+
namespace Responses {
|
|
742
|
+
export type $200 = /* An entity that describes a billing event such as a future installment or a reimbursement back to the customer. */ Components.Schemas.BillingEvent;
|
|
743
|
+
}
|
|
744
|
+
}
|
|
745
|
+
namespace UpdateContractEntity {
|
|
746
|
+
namespace Parameters {
|
|
747
|
+
export type Id = string;
|
|
748
|
+
}
|
|
749
|
+
export interface PathParameters {
|
|
750
|
+
id: Parameters.Id;
|
|
751
|
+
}
|
|
752
|
+
export type RequestBody = Components.Schemas.Contract;
|
|
753
|
+
namespace Responses {
|
|
754
|
+
export type $200 = Components.Schemas.ContractItem;
|
|
755
|
+
}
|
|
756
|
+
}
|
|
757
|
+
}
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
interface OperationMethods {
|
|
761
|
+
/**
|
|
762
|
+
* getBillingEvents - getBillingEvents
|
|
763
|
+
*
|
|
764
|
+
* Get and filter billing events such as installments and reimbursements.
|
|
765
|
+
*/
|
|
766
|
+
'getBillingEvents'(
|
|
767
|
+
parameters?: Parameters<Paths.GetBillingEvents.QueryParameters> | null,
|
|
768
|
+
data?: any,
|
|
769
|
+
config?: AxiosRequestConfig
|
|
770
|
+
): OperationResponse<Paths.GetBillingEvents.Responses.$200>
|
|
771
|
+
/**
|
|
772
|
+
* createBillingEvent - createBillingEvent
|
|
773
|
+
*
|
|
774
|
+
* Create a new billing event.
|
|
775
|
+
*/
|
|
776
|
+
'createBillingEvent'(
|
|
777
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
778
|
+
data?: Paths.CreateBillingEvent.RequestBody,
|
|
779
|
+
config?: AxiosRequestConfig
|
|
780
|
+
): OperationResponse<Paths.CreateBillingEvent.Responses.$201>
|
|
781
|
+
/**
|
|
782
|
+
* getBillingEvent - getBillingEvent
|
|
783
|
+
*
|
|
784
|
+
* Get a single billing event by ID.
|
|
785
|
+
*/
|
|
786
|
+
'getBillingEvent'(
|
|
787
|
+
parameters?: Parameters<Paths.GetBillingEvent.PathParameters> | null,
|
|
788
|
+
data?: any,
|
|
789
|
+
config?: AxiosRequestConfig
|
|
790
|
+
): OperationResponse<Paths.GetBillingEvent.Responses.$200>
|
|
791
|
+
/**
|
|
792
|
+
* updateBillingEvent - updateBillingEvent
|
|
793
|
+
*
|
|
794
|
+
* Update an existing billing event.
|
|
795
|
+
*/
|
|
796
|
+
'updateBillingEvent'(
|
|
797
|
+
parameters?: Parameters<Paths.UpdateBillingEvent.PathParameters> | null,
|
|
798
|
+
data?: Paths.UpdateBillingEvent.RequestBody,
|
|
799
|
+
config?: AxiosRequestConfig
|
|
800
|
+
): OperationResponse<Paths.UpdateBillingEvent.Responses.$200>
|
|
801
|
+
/**
|
|
802
|
+
* deleteBillingEvent - deleteBillingEvent
|
|
803
|
+
*
|
|
804
|
+
* Delete an existing billing event.
|
|
805
|
+
*/
|
|
806
|
+
'deleteBillingEvent'(
|
|
807
|
+
parameters?: Parameters<Paths.DeleteBillingEvent.PathParameters> | null,
|
|
808
|
+
data?: any,
|
|
809
|
+
config?: AxiosRequestConfig
|
|
810
|
+
): OperationResponse<Paths.DeleteBillingEvent.Responses.$204>
|
|
811
|
+
/**
|
|
812
|
+
* getBillingEventByExternalId - getBillingEventByExternalId
|
|
813
|
+
*
|
|
814
|
+
* Get a single billing event by External ID.
|
|
815
|
+
*/
|
|
816
|
+
'getBillingEventByExternalId'(
|
|
817
|
+
parameters?: Parameters<Paths.GetBillingEventByExternalId.PathParameters> | null,
|
|
818
|
+
data?: any,
|
|
819
|
+
config?: AxiosRequestConfig
|
|
820
|
+
): OperationResponse<Paths.GetBillingEventByExternalId.Responses.$200>
|
|
821
|
+
/**
|
|
822
|
+
* createContractEntity - createContractEntity
|
|
823
|
+
*
|
|
824
|
+
* Create a new contract entity.
|
|
825
|
+
*/
|
|
826
|
+
'createContractEntity'(
|
|
827
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
828
|
+
data?: Paths.CreateContractEntity.RequestBody,
|
|
829
|
+
config?: AxiosRequestConfig
|
|
830
|
+
): OperationResponse<Paths.CreateContractEntity.Responses.$201>
|
|
831
|
+
/**
|
|
832
|
+
* updateContractEntity - updateContractEntity
|
|
833
|
+
*
|
|
834
|
+
* Update an existing contract entity.
|
|
835
|
+
*/
|
|
836
|
+
'updateContractEntity'(
|
|
837
|
+
parameters?: Parameters<Paths.UpdateContractEntity.PathParameters> | null,
|
|
838
|
+
data?: Paths.UpdateContractEntity.RequestBody,
|
|
839
|
+
config?: AxiosRequestConfig
|
|
840
|
+
): OperationResponse<Paths.UpdateContractEntity.Responses.$200>
|
|
841
|
+
/**
|
|
842
|
+
* deleteContractEntity - deleteContractEntity
|
|
843
|
+
*
|
|
844
|
+
* Delete an existing contract entity.
|
|
845
|
+
*/
|
|
846
|
+
'deleteContractEntity'(
|
|
847
|
+
parameters?: Parameters<Paths.DeleteContractEntity.PathParameters> | null,
|
|
848
|
+
data?: any,
|
|
849
|
+
config?: AxiosRequestConfig
|
|
850
|
+
): OperationResponse<Paths.DeleteContractEntity.Responses.$204>
|
|
851
|
+
/**
|
|
852
|
+
* getCustomerBalance - getCustomerBalance
|
|
853
|
+
*
|
|
854
|
+
* Get total balance across all contracts and orders of a customer entity.
|
|
855
|
+
*/
|
|
856
|
+
'getCustomerBalance'(
|
|
857
|
+
parameters?: Parameters<Paths.GetCustomerBalance.PathParameters> | null,
|
|
858
|
+
data?: any,
|
|
859
|
+
config?: AxiosRequestConfig
|
|
860
|
+
): OperationResponse<Paths.GetCustomerBalance.Responses.$200>
|
|
861
|
+
}
|
|
862
|
+
|
|
863
|
+
interface PathsDictionary {
|
|
864
|
+
['/v1/billing/events']: {
|
|
865
|
+
/**
|
|
866
|
+
* getBillingEvents - getBillingEvents
|
|
867
|
+
*
|
|
868
|
+
* Get and filter billing events such as installments and reimbursements.
|
|
869
|
+
*/
|
|
870
|
+
'get'(
|
|
871
|
+
parameters?: Parameters<Paths.GetBillingEvents.QueryParameters> | null,
|
|
872
|
+
data?: any,
|
|
873
|
+
config?: AxiosRequestConfig
|
|
874
|
+
): OperationResponse<Paths.GetBillingEvents.Responses.$200>
|
|
875
|
+
/**
|
|
876
|
+
* createBillingEvent - createBillingEvent
|
|
877
|
+
*
|
|
878
|
+
* Create a new billing event.
|
|
879
|
+
*/
|
|
880
|
+
'post'(
|
|
881
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
882
|
+
data?: Paths.CreateBillingEvent.RequestBody,
|
|
883
|
+
config?: AxiosRequestConfig
|
|
884
|
+
): OperationResponse<Paths.CreateBillingEvent.Responses.$201>
|
|
885
|
+
}
|
|
886
|
+
['/v1/billing/events/{id}']: {
|
|
887
|
+
/**
|
|
888
|
+
* getBillingEvent - getBillingEvent
|
|
889
|
+
*
|
|
890
|
+
* Get a single billing event by ID.
|
|
891
|
+
*/
|
|
892
|
+
'get'(
|
|
893
|
+
parameters?: Parameters<Paths.GetBillingEvent.PathParameters> | null,
|
|
894
|
+
data?: any,
|
|
895
|
+
config?: AxiosRequestConfig
|
|
896
|
+
): OperationResponse<Paths.GetBillingEvent.Responses.$200>
|
|
897
|
+
/**
|
|
898
|
+
* updateBillingEvent - updateBillingEvent
|
|
899
|
+
*
|
|
900
|
+
* Update an existing billing event.
|
|
901
|
+
*/
|
|
902
|
+
'patch'(
|
|
903
|
+
parameters?: Parameters<Paths.UpdateBillingEvent.PathParameters> | null,
|
|
904
|
+
data?: Paths.UpdateBillingEvent.RequestBody,
|
|
905
|
+
config?: AxiosRequestConfig
|
|
906
|
+
): OperationResponse<Paths.UpdateBillingEvent.Responses.$200>
|
|
907
|
+
/**
|
|
908
|
+
* deleteBillingEvent - deleteBillingEvent
|
|
909
|
+
*
|
|
910
|
+
* Delete an existing billing event.
|
|
911
|
+
*/
|
|
912
|
+
'delete'(
|
|
913
|
+
parameters?: Parameters<Paths.DeleteBillingEvent.PathParameters> | null,
|
|
914
|
+
data?: any,
|
|
915
|
+
config?: AxiosRequestConfig
|
|
916
|
+
): OperationResponse<Paths.DeleteBillingEvent.Responses.$204>
|
|
917
|
+
}
|
|
918
|
+
['/v1/billing/external/{external_id}']: {
|
|
919
|
+
/**
|
|
920
|
+
* getBillingEventByExternalId - getBillingEventByExternalId
|
|
921
|
+
*
|
|
922
|
+
* Get a single billing event by External ID.
|
|
923
|
+
*/
|
|
924
|
+
'get'(
|
|
925
|
+
parameters?: Parameters<Paths.GetBillingEventByExternalId.PathParameters> | null,
|
|
926
|
+
data?: any,
|
|
927
|
+
config?: AxiosRequestConfig
|
|
928
|
+
): OperationResponse<Paths.GetBillingEventByExternalId.Responses.$200>
|
|
929
|
+
}
|
|
930
|
+
['/v1/billing/contracts']: {
|
|
931
|
+
/**
|
|
932
|
+
* createContractEntity - createContractEntity
|
|
933
|
+
*
|
|
934
|
+
* Create a new contract entity.
|
|
935
|
+
*/
|
|
936
|
+
'post'(
|
|
937
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
938
|
+
data?: Paths.CreateContractEntity.RequestBody,
|
|
939
|
+
config?: AxiosRequestConfig
|
|
940
|
+
): OperationResponse<Paths.CreateContractEntity.Responses.$201>
|
|
941
|
+
}
|
|
942
|
+
['/v1/billing/contracts/{id}']: {
|
|
943
|
+
/**
|
|
944
|
+
* updateContractEntity - updateContractEntity
|
|
945
|
+
*
|
|
946
|
+
* Update an existing contract entity.
|
|
947
|
+
*/
|
|
948
|
+
'patch'(
|
|
949
|
+
parameters?: Parameters<Paths.UpdateContractEntity.PathParameters> | null,
|
|
950
|
+
data?: Paths.UpdateContractEntity.RequestBody,
|
|
951
|
+
config?: AxiosRequestConfig
|
|
952
|
+
): OperationResponse<Paths.UpdateContractEntity.Responses.$200>
|
|
953
|
+
/**
|
|
954
|
+
* deleteContractEntity - deleteContractEntity
|
|
955
|
+
*
|
|
956
|
+
* Delete an existing contract entity.
|
|
957
|
+
*/
|
|
958
|
+
'delete'(
|
|
959
|
+
parameters?: Parameters<Paths.DeleteContractEntity.PathParameters> | null,
|
|
960
|
+
data?: any,
|
|
961
|
+
config?: AxiosRequestConfig
|
|
962
|
+
): OperationResponse<Paths.DeleteContractEntity.Responses.$204>
|
|
963
|
+
}
|
|
964
|
+
['/v1/billing/customers/{id}/balance']: {
|
|
965
|
+
/**
|
|
966
|
+
* getCustomerBalance - getCustomerBalance
|
|
967
|
+
*
|
|
968
|
+
* Get total balance across all contracts and orders of a customer entity.
|
|
969
|
+
*/
|
|
970
|
+
'get'(
|
|
971
|
+
parameters?: Parameters<Paths.GetCustomerBalance.PathParameters> | null,
|
|
972
|
+
data?: any,
|
|
973
|
+
config?: AxiosRequestConfig
|
|
974
|
+
): OperationResponse<Paths.GetCustomerBalance.Responses.$200>
|
|
975
|
+
}
|
|
976
|
+
}
|
|
977
|
+
|
|
978
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
type Balance = Components.Schemas.Balance;
|
|
982
|
+
type BaseBillingEvent = Components.Schemas.BaseBillingEvent;
|
|
983
|
+
type BaseEntity = Components.Schemas.BaseEntity;
|
|
984
|
+
type BillingEvent = Components.Schemas.BillingEvent;
|
|
985
|
+
type Contract = Components.Schemas.Contract;
|
|
986
|
+
type ContractItem = Components.Schemas.ContractItem;
|
|
987
|
+
type Currency = Components.Schemas.Currency;
|
|
988
|
+
type EntityId = Components.Schemas.EntityId;
|
|
989
|
+
type EntityRelationItem = Components.Schemas.EntityRelationItem;
|
|
990
|
+
type EntitySlug = Components.Schemas.EntitySlug;
|
|
991
|
+
type InstallmentEvent = Components.Schemas.InstallmentEvent;
|
|
992
|
+
type ReimbursementEvent = Components.Schemas.ReimbursementEvent;
|
|
993
|
+
|
|
994
|
+
export type { Balance as B, Client as C, EntityId as E, InstallmentEvent as I, OperationMethods as O, PathsDictionary as P, ReimbursementEvent as R, BaseBillingEvent as a, BaseEntity as b, BillingEvent as c, Contract as d, ContractItem as e, Currency as f, EntityRelationItem as g, EntitySlug as h };
|