@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,1253 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/* Auto-copied from permissions-client */
|
|
5
|
+
/* eslint-disable */
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
declare namespace Components {
|
|
10
|
+
namespace Schemas {
|
|
11
|
+
/**
|
|
12
|
+
* A role attached to an user
|
|
13
|
+
*/
|
|
14
|
+
export interface Assignment {
|
|
15
|
+
user_id?: /**
|
|
16
|
+
* Id of a user
|
|
17
|
+
* example:
|
|
18
|
+
* 1
|
|
19
|
+
*/
|
|
20
|
+
UserId;
|
|
21
|
+
roles?: /**
|
|
22
|
+
* Format: <organization_id>:<slug>
|
|
23
|
+
* example:
|
|
24
|
+
* 123:owner
|
|
25
|
+
*/
|
|
26
|
+
RoleId[];
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* List of role ids attached to an user
|
|
30
|
+
*/
|
|
31
|
+
export type Assignments = /**
|
|
32
|
+
* Format: <organization_id>:<slug>
|
|
33
|
+
* example:
|
|
34
|
+
* 123:owner
|
|
35
|
+
*/
|
|
36
|
+
RoleId[];
|
|
37
|
+
export interface BaseRole {
|
|
38
|
+
id: /**
|
|
39
|
+
* Format: <organization_id>:<slug>
|
|
40
|
+
* example:
|
|
41
|
+
* 123:owner
|
|
42
|
+
*/
|
|
43
|
+
RoleId;
|
|
44
|
+
/**
|
|
45
|
+
* Human-friendly name for the role
|
|
46
|
+
* example:
|
|
47
|
+
* Owner
|
|
48
|
+
*/
|
|
49
|
+
name: string;
|
|
50
|
+
/**
|
|
51
|
+
* URL-friendly name for the role
|
|
52
|
+
* example:
|
|
53
|
+
* owner
|
|
54
|
+
*/
|
|
55
|
+
slug: string;
|
|
56
|
+
/**
|
|
57
|
+
* Type of the role
|
|
58
|
+
*/
|
|
59
|
+
type: string;
|
|
60
|
+
/**
|
|
61
|
+
* date and time then the role will expire
|
|
62
|
+
* example:
|
|
63
|
+
* 2028-07-21T17:32:28Z
|
|
64
|
+
*/
|
|
65
|
+
expires_at?: string; // date-time
|
|
66
|
+
organization_id: /**
|
|
67
|
+
* Id of an organization
|
|
68
|
+
* example:
|
|
69
|
+
* 123
|
|
70
|
+
*/
|
|
71
|
+
OrganizationId;
|
|
72
|
+
/**
|
|
73
|
+
* List of grants (permissions) applied to the role
|
|
74
|
+
*/
|
|
75
|
+
grants: Grant[];
|
|
76
|
+
}
|
|
77
|
+
export interface BaseRoleForCreate {
|
|
78
|
+
id?: /**
|
|
79
|
+
* Format: <organization_id>:<slug>
|
|
80
|
+
* example:
|
|
81
|
+
* 123:owner
|
|
82
|
+
*/
|
|
83
|
+
RoleId;
|
|
84
|
+
/**
|
|
85
|
+
* Human-friendly name for the role
|
|
86
|
+
* example:
|
|
87
|
+
* Owner
|
|
88
|
+
*/
|
|
89
|
+
name: string;
|
|
90
|
+
/**
|
|
91
|
+
* URL-friendly name for the role
|
|
92
|
+
* example:
|
|
93
|
+
* owner
|
|
94
|
+
*/
|
|
95
|
+
slug: string;
|
|
96
|
+
/**
|
|
97
|
+
* Type of the role
|
|
98
|
+
*/
|
|
99
|
+
type: string;
|
|
100
|
+
/**
|
|
101
|
+
* date and time then the role will expire
|
|
102
|
+
* example:
|
|
103
|
+
* 2028-07-21T17:32:28Z
|
|
104
|
+
*/
|
|
105
|
+
expires_at?: string; // date-time
|
|
106
|
+
organization_id?: /**
|
|
107
|
+
* Id of an organization
|
|
108
|
+
* example:
|
|
109
|
+
* 123
|
|
110
|
+
*/
|
|
111
|
+
OrganizationId;
|
|
112
|
+
/**
|
|
113
|
+
* List of grants (permissions) applied to the role
|
|
114
|
+
*/
|
|
115
|
+
grants: Grant[];
|
|
116
|
+
}
|
|
117
|
+
export type CreateRolePayload = {
|
|
118
|
+
/**
|
|
119
|
+
* Type of the role
|
|
120
|
+
*/
|
|
121
|
+
type: "user_role";
|
|
122
|
+
/**
|
|
123
|
+
* Optional parent role that this role inherits from. Must be an `org_role` or a sharing role of type `share_role` or `partner_role`.
|
|
124
|
+
* example:
|
|
125
|
+
* 123:owner
|
|
126
|
+
*/
|
|
127
|
+
parent_role?: string;
|
|
128
|
+
/**
|
|
129
|
+
* List of grants (permissions) applied to the role
|
|
130
|
+
*/
|
|
131
|
+
grants: Grant[];
|
|
132
|
+
id?: /**
|
|
133
|
+
* Format: <organization_id>:<slug>
|
|
134
|
+
* example:
|
|
135
|
+
* 123:owner
|
|
136
|
+
*/
|
|
137
|
+
RoleId;
|
|
138
|
+
/**
|
|
139
|
+
* Human-friendly name for the role
|
|
140
|
+
* example:
|
|
141
|
+
* Owner
|
|
142
|
+
*/
|
|
143
|
+
name: string;
|
|
144
|
+
/**
|
|
145
|
+
* URL-friendly name for the role
|
|
146
|
+
* example:
|
|
147
|
+
* owner
|
|
148
|
+
*/
|
|
149
|
+
slug: string;
|
|
150
|
+
/**
|
|
151
|
+
* date and time then the role will expire
|
|
152
|
+
* example:
|
|
153
|
+
* 2028-07-21T17:32:28Z
|
|
154
|
+
*/
|
|
155
|
+
expires_at?: string; // date-time
|
|
156
|
+
organization_id?: /**
|
|
157
|
+
* Id of an organization
|
|
158
|
+
* example:
|
|
159
|
+
* 123
|
|
160
|
+
*/
|
|
161
|
+
OrganizationId;
|
|
162
|
+
} | {
|
|
163
|
+
/**
|
|
164
|
+
* Type of the role
|
|
165
|
+
*/
|
|
166
|
+
type: "org_role";
|
|
167
|
+
/**
|
|
168
|
+
* The pricing tier of the organization this root role is based on
|
|
169
|
+
* example:
|
|
170
|
+
* Professional
|
|
171
|
+
*/
|
|
172
|
+
pricing_tier?: string;
|
|
173
|
+
/**
|
|
174
|
+
* List of grants (permissions) applied to the role
|
|
175
|
+
*/
|
|
176
|
+
grants: Grant[];
|
|
177
|
+
id?: /**
|
|
178
|
+
* Format: <organization_id>:<slug>
|
|
179
|
+
* example:
|
|
180
|
+
* 123:owner
|
|
181
|
+
*/
|
|
182
|
+
RoleId;
|
|
183
|
+
/**
|
|
184
|
+
* Human-friendly name for the role
|
|
185
|
+
* example:
|
|
186
|
+
* Owner
|
|
187
|
+
*/
|
|
188
|
+
name: string;
|
|
189
|
+
/**
|
|
190
|
+
* URL-friendly name for the role
|
|
191
|
+
* example:
|
|
192
|
+
* owner
|
|
193
|
+
*/
|
|
194
|
+
slug: string;
|
|
195
|
+
/**
|
|
196
|
+
* date and time then the role will expire
|
|
197
|
+
* example:
|
|
198
|
+
* 2028-07-21T17:32:28Z
|
|
199
|
+
*/
|
|
200
|
+
expires_at?: string; // date-time
|
|
201
|
+
organization_id?: /**
|
|
202
|
+
* Id of an organization
|
|
203
|
+
* example:
|
|
204
|
+
* 123
|
|
205
|
+
*/
|
|
206
|
+
OrganizationId;
|
|
207
|
+
} | {
|
|
208
|
+
/**
|
|
209
|
+
* Type of the role
|
|
210
|
+
*/
|
|
211
|
+
type: "share_role";
|
|
212
|
+
/**
|
|
213
|
+
* List of grants (permissions) applied to the role
|
|
214
|
+
*/
|
|
215
|
+
grants: Grant[];
|
|
216
|
+
id?: /**
|
|
217
|
+
* Format: <organization_id>:<slug>
|
|
218
|
+
* example:
|
|
219
|
+
* 123:owner
|
|
220
|
+
*/
|
|
221
|
+
RoleId;
|
|
222
|
+
/**
|
|
223
|
+
* Human-friendly name for the role
|
|
224
|
+
* example:
|
|
225
|
+
* Owner
|
|
226
|
+
*/
|
|
227
|
+
name: string;
|
|
228
|
+
/**
|
|
229
|
+
* URL-friendly name for the role
|
|
230
|
+
* example:
|
|
231
|
+
* owner
|
|
232
|
+
*/
|
|
233
|
+
slug: string;
|
|
234
|
+
/**
|
|
235
|
+
* date and time then the role will expire
|
|
236
|
+
* example:
|
|
237
|
+
* 2028-07-21T17:32:28Z
|
|
238
|
+
*/
|
|
239
|
+
expires_at?: string; // date-time
|
|
240
|
+
organization_id?: /**
|
|
241
|
+
* Id of an organization
|
|
242
|
+
* example:
|
|
243
|
+
* 123
|
|
244
|
+
*/
|
|
245
|
+
OrganizationId;
|
|
246
|
+
} | {
|
|
247
|
+
/**
|
|
248
|
+
* Type of the role
|
|
249
|
+
*/
|
|
250
|
+
type: "partner_role";
|
|
251
|
+
/**
|
|
252
|
+
* Id of an organization
|
|
253
|
+
* example:
|
|
254
|
+
* 123
|
|
255
|
+
*/
|
|
256
|
+
partner_org_id?: string;
|
|
257
|
+
/**
|
|
258
|
+
* List of grants (permissions) applied to the role
|
|
259
|
+
*/
|
|
260
|
+
grants: Grant[];
|
|
261
|
+
id?: /**
|
|
262
|
+
* Format: <organization_id>:<slug>
|
|
263
|
+
* example:
|
|
264
|
+
* 123:owner
|
|
265
|
+
*/
|
|
266
|
+
RoleId;
|
|
267
|
+
/**
|
|
268
|
+
* Human-friendly name for the role
|
|
269
|
+
* example:
|
|
270
|
+
* Owner
|
|
271
|
+
*/
|
|
272
|
+
name: string;
|
|
273
|
+
/**
|
|
274
|
+
* URL-friendly name for the role
|
|
275
|
+
* example:
|
|
276
|
+
* owner
|
|
277
|
+
*/
|
|
278
|
+
slug: string;
|
|
279
|
+
/**
|
|
280
|
+
* date and time then the role will expire
|
|
281
|
+
* example:
|
|
282
|
+
* 2028-07-21T17:32:28Z
|
|
283
|
+
*/
|
|
284
|
+
expires_at?: string; // date-time
|
|
285
|
+
organization_id?: /**
|
|
286
|
+
* Id of an organization
|
|
287
|
+
* example:
|
|
288
|
+
* 123
|
|
289
|
+
*/
|
|
290
|
+
OrganizationId;
|
|
291
|
+
} | {
|
|
292
|
+
/**
|
|
293
|
+
* Type of the role
|
|
294
|
+
*/
|
|
295
|
+
type: "portal_role";
|
|
296
|
+
/**
|
|
297
|
+
* List of grants (permissions) applied to the role
|
|
298
|
+
*/
|
|
299
|
+
grants: Grant[];
|
|
300
|
+
id?: /**
|
|
301
|
+
* Format: <organization_id>:<slug>
|
|
302
|
+
* example:
|
|
303
|
+
* 123:owner
|
|
304
|
+
*/
|
|
305
|
+
RoleId;
|
|
306
|
+
/**
|
|
307
|
+
* Human-friendly name for the role
|
|
308
|
+
* example:
|
|
309
|
+
* Owner
|
|
310
|
+
*/
|
|
311
|
+
name: string;
|
|
312
|
+
/**
|
|
313
|
+
* URL-friendly name for the role
|
|
314
|
+
* example:
|
|
315
|
+
* owner
|
|
316
|
+
*/
|
|
317
|
+
slug: string;
|
|
318
|
+
/**
|
|
319
|
+
* date and time then the role will expire
|
|
320
|
+
* example:
|
|
321
|
+
* 2028-07-21T17:32:28Z
|
|
322
|
+
*/
|
|
323
|
+
expires_at?: string; // date-time
|
|
324
|
+
organization_id?: /**
|
|
325
|
+
* Id of an organization
|
|
326
|
+
* example:
|
|
327
|
+
* 123
|
|
328
|
+
*/
|
|
329
|
+
OrganizationId;
|
|
330
|
+
};
|
|
331
|
+
/**
|
|
332
|
+
* Check if attribute equals to any of the values
|
|
333
|
+
*/
|
|
334
|
+
export interface EqualsCondition {
|
|
335
|
+
/**
|
|
336
|
+
* example:
|
|
337
|
+
* workflows.primary.task_name
|
|
338
|
+
*/
|
|
339
|
+
attribute: string;
|
|
340
|
+
operation: "equals";
|
|
341
|
+
values: any[];
|
|
342
|
+
}
|
|
343
|
+
/**
|
|
344
|
+
* Error response
|
|
345
|
+
*/
|
|
346
|
+
export interface Error {
|
|
347
|
+
/**
|
|
348
|
+
* Error message
|
|
349
|
+
* example:
|
|
350
|
+
* Parent role 123:nonexistent does not exist
|
|
351
|
+
*/
|
|
352
|
+
message: string;
|
|
353
|
+
}
|
|
354
|
+
export interface Grant {
|
|
355
|
+
/**
|
|
356
|
+
* example:
|
|
357
|
+
* entity-read
|
|
358
|
+
*/
|
|
359
|
+
action: string;
|
|
360
|
+
/**
|
|
361
|
+
* example:
|
|
362
|
+
* entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947
|
|
363
|
+
*/
|
|
364
|
+
resource?: string;
|
|
365
|
+
effect?: "allow" | "deny";
|
|
366
|
+
conditions?: /* An additional condition that must be met for the grant */ GrantCondition[];
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* An additional condition that must be met for the grant
|
|
370
|
+
*/
|
|
371
|
+
export type GrantCondition = /* An additional condition that must be met for the grant */ /* Check if attribute equals to any of the values */ EqualsCondition;
|
|
372
|
+
export interface GrantWithDependencies {
|
|
373
|
+
/**
|
|
374
|
+
* example:
|
|
375
|
+
* entity-read
|
|
376
|
+
*/
|
|
377
|
+
action: string;
|
|
378
|
+
/**
|
|
379
|
+
* example:
|
|
380
|
+
* entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947
|
|
381
|
+
*/
|
|
382
|
+
resource?: string;
|
|
383
|
+
effect?: "allow" | "deny";
|
|
384
|
+
conditions?: /* An additional condition that must be met for the grant */ GrantCondition[];
|
|
385
|
+
/**
|
|
386
|
+
* Provided additional dependencies, exploded when storing the role
|
|
387
|
+
*/
|
|
388
|
+
dependencies?: Grant[];
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
* A role attached to an user
|
|
392
|
+
*/
|
|
393
|
+
export interface InternalAssignment {
|
|
394
|
+
userId?: /**
|
|
395
|
+
* Id of a user
|
|
396
|
+
* example:
|
|
397
|
+
* 1
|
|
398
|
+
*/
|
|
399
|
+
UserId;
|
|
400
|
+
roles?: /**
|
|
401
|
+
* Format: <organization_id>:<slug>
|
|
402
|
+
* example:
|
|
403
|
+
* 123:owner
|
|
404
|
+
*/
|
|
405
|
+
RoleId[];
|
|
406
|
+
}
|
|
407
|
+
/**
|
|
408
|
+
* All roles attached to an users of an organization
|
|
409
|
+
*/
|
|
410
|
+
export interface OrgAssignments {
|
|
411
|
+
organizationId?: /**
|
|
412
|
+
* Id of an organization
|
|
413
|
+
* example:
|
|
414
|
+
* 123
|
|
415
|
+
*/
|
|
416
|
+
OrganizationId;
|
|
417
|
+
assignments?: /* A role attached to an user */ InternalAssignment[];
|
|
418
|
+
}
|
|
419
|
+
/**
|
|
420
|
+
* A role automatically applied to all users in an organization.
|
|
421
|
+
*/
|
|
422
|
+
export interface OrgRole {
|
|
423
|
+
id: /**
|
|
424
|
+
* Format: <organization_id>:<slug>
|
|
425
|
+
* example:
|
|
426
|
+
* 123:owner
|
|
427
|
+
*/
|
|
428
|
+
RoleId;
|
|
429
|
+
/**
|
|
430
|
+
* Human-friendly name for the role
|
|
431
|
+
* example:
|
|
432
|
+
* Owner
|
|
433
|
+
*/
|
|
434
|
+
name: string;
|
|
435
|
+
/**
|
|
436
|
+
* URL-friendly name for the role
|
|
437
|
+
* example:
|
|
438
|
+
* owner
|
|
439
|
+
*/
|
|
440
|
+
slug: string;
|
|
441
|
+
/**
|
|
442
|
+
* Type of the role
|
|
443
|
+
*/
|
|
444
|
+
type: "org_role";
|
|
445
|
+
/**
|
|
446
|
+
* date and time then the role will expire
|
|
447
|
+
* example:
|
|
448
|
+
* 2028-07-21T17:32:28Z
|
|
449
|
+
*/
|
|
450
|
+
expires_at?: string; // date-time
|
|
451
|
+
organization_id: /**
|
|
452
|
+
* Id of an organization
|
|
453
|
+
* example:
|
|
454
|
+
* 123
|
|
455
|
+
*/
|
|
456
|
+
OrganizationId;
|
|
457
|
+
/**
|
|
458
|
+
* List of grants (permissions) applied to the role
|
|
459
|
+
*/
|
|
460
|
+
grants: Grant[];
|
|
461
|
+
/**
|
|
462
|
+
* The pricing tier of the organization this root role is based on
|
|
463
|
+
* example:
|
|
464
|
+
* Professional
|
|
465
|
+
*/
|
|
466
|
+
pricing_tier?: string;
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* All roles attached to an users of an organization
|
|
470
|
+
*/
|
|
471
|
+
export interface OrgRoles {
|
|
472
|
+
organizationId?: /**
|
|
473
|
+
* Id of an organization
|
|
474
|
+
* example:
|
|
475
|
+
* 123
|
|
476
|
+
*/
|
|
477
|
+
OrganizationId;
|
|
478
|
+
roles?: Role[];
|
|
479
|
+
}
|
|
480
|
+
/**
|
|
481
|
+
* Id of an organization
|
|
482
|
+
* example:
|
|
483
|
+
* 123
|
|
484
|
+
*/
|
|
485
|
+
export type OrganizationId = string;
|
|
486
|
+
/**
|
|
487
|
+
* A role that appears in another organization's role list that can be assigned but not modified by the partner organization.
|
|
488
|
+
*/
|
|
489
|
+
export interface PartnerRole {
|
|
490
|
+
id: /**
|
|
491
|
+
* Format: <organization_id>:<slug>
|
|
492
|
+
* example:
|
|
493
|
+
* 123:owner
|
|
494
|
+
*/
|
|
495
|
+
RoleId;
|
|
496
|
+
/**
|
|
497
|
+
* Human-friendly name for the role
|
|
498
|
+
* example:
|
|
499
|
+
* Owner
|
|
500
|
+
*/
|
|
501
|
+
name: string;
|
|
502
|
+
/**
|
|
503
|
+
* URL-friendly name for the role
|
|
504
|
+
* example:
|
|
505
|
+
* owner
|
|
506
|
+
*/
|
|
507
|
+
slug: string;
|
|
508
|
+
/**
|
|
509
|
+
* Type of the role
|
|
510
|
+
*/
|
|
511
|
+
type: "partner_role";
|
|
512
|
+
/**
|
|
513
|
+
* date and time then the role will expire
|
|
514
|
+
* example:
|
|
515
|
+
* 2028-07-21T17:32:28Z
|
|
516
|
+
*/
|
|
517
|
+
expires_at?: string; // date-time
|
|
518
|
+
organization_id: /**
|
|
519
|
+
* Id of an organization
|
|
520
|
+
* example:
|
|
521
|
+
* 123
|
|
522
|
+
*/
|
|
523
|
+
OrganizationId;
|
|
524
|
+
/**
|
|
525
|
+
* List of grants (permissions) applied to the role
|
|
526
|
+
*/
|
|
527
|
+
grants: Grant[];
|
|
528
|
+
/**
|
|
529
|
+
* Id of an organization
|
|
530
|
+
* example:
|
|
531
|
+
* 123
|
|
532
|
+
*/
|
|
533
|
+
partner_org_id?: string;
|
|
534
|
+
/**
|
|
535
|
+
* Maximum number of users that can be assigned this role (vendor-enforced limit, can only be set via internal auth)
|
|
536
|
+
*/
|
|
537
|
+
vendor_enforced_user_limit?: number;
|
|
538
|
+
}
|
|
539
|
+
/**
|
|
540
|
+
* A role that is applied to end customers and installers using the Portals
|
|
541
|
+
*/
|
|
542
|
+
export interface PortalRole {
|
|
543
|
+
id: /**
|
|
544
|
+
* Format: <organization_id>:<slug>
|
|
545
|
+
* example:
|
|
546
|
+
* 123:owner
|
|
547
|
+
*/
|
|
548
|
+
RoleId;
|
|
549
|
+
/**
|
|
550
|
+
* Human-friendly name for the role
|
|
551
|
+
* example:
|
|
552
|
+
* Owner
|
|
553
|
+
*/
|
|
554
|
+
name: string;
|
|
555
|
+
/**
|
|
556
|
+
* URL-friendly name for the role
|
|
557
|
+
* example:
|
|
558
|
+
* owner
|
|
559
|
+
*/
|
|
560
|
+
slug: string;
|
|
561
|
+
/**
|
|
562
|
+
* Type of the role
|
|
563
|
+
*/
|
|
564
|
+
type: "portal_role";
|
|
565
|
+
/**
|
|
566
|
+
* date and time then the role will expire
|
|
567
|
+
* example:
|
|
568
|
+
* 2028-07-21T17:32:28Z
|
|
569
|
+
*/
|
|
570
|
+
expires_at?: string; // date-time
|
|
571
|
+
organization_id: /**
|
|
572
|
+
* Id of an organization
|
|
573
|
+
* example:
|
|
574
|
+
* 123
|
|
575
|
+
*/
|
|
576
|
+
OrganizationId;
|
|
577
|
+
/**
|
|
578
|
+
* List of grants (permissions) applied to the role
|
|
579
|
+
*/
|
|
580
|
+
grants: Grant[];
|
|
581
|
+
}
|
|
582
|
+
export type Role = /* A standard user role. Must be explicitly assigned to users. */ UserRole | /* A role automatically applied to all users in an organization. */ OrgRole | /* A role that can be assigned to users in other organizations for sharing purposes. */ ShareRole | /* A role that appears in another organization's role list that can be assigned but not modified by the partner organization. */ PartnerRole | /* A role that is applied to end customers and installers using the Portals */ PortalRole;
|
|
583
|
+
/**
|
|
584
|
+
* Format: <organization_id>:<slug>
|
|
585
|
+
* example:
|
|
586
|
+
* 123:owner
|
|
587
|
+
*/
|
|
588
|
+
export type RoleId = string;
|
|
589
|
+
export type RolePayload = {
|
|
590
|
+
grants?: GrantWithDependencies[];
|
|
591
|
+
} & (/* A standard user role. Must be explicitly assigned to users. */ UserRole | /* A role automatically applied to all users in an organization. */ OrgRole | /* A role that can be assigned to users in other organizations for sharing purposes. */ ShareRole | /* A role that appears in another organization's role list that can be assigned but not modified by the partner organization. */ PartnerRole | /* A role that is applied to end customers and installers using the Portals */ PortalRole);
|
|
592
|
+
export interface RoleSearchInput {
|
|
593
|
+
/**
|
|
594
|
+
* List of role ids to filter by
|
|
595
|
+
* example:
|
|
596
|
+
* [
|
|
597
|
+
* "123:manager",
|
|
598
|
+
* "456:owner"
|
|
599
|
+
* ]
|
|
600
|
+
*/
|
|
601
|
+
role_ids?: /**
|
|
602
|
+
* Format: <organization_id>:<slug>
|
|
603
|
+
* example:
|
|
604
|
+
* 123:owner
|
|
605
|
+
*/
|
|
606
|
+
RoleId[];
|
|
607
|
+
/**
|
|
608
|
+
* List of organization ids to filter by
|
|
609
|
+
* example:
|
|
610
|
+
* [
|
|
611
|
+
* "123",
|
|
612
|
+
* "456"
|
|
613
|
+
* ]
|
|
614
|
+
*/
|
|
615
|
+
org_ids?: /**
|
|
616
|
+
* Id of an organization
|
|
617
|
+
* example:
|
|
618
|
+
* 123
|
|
619
|
+
*/
|
|
620
|
+
OrganizationId[];
|
|
621
|
+
/**
|
|
622
|
+
* List of role slugs to filter by
|
|
623
|
+
* example:
|
|
624
|
+
* [
|
|
625
|
+
* "manager",
|
|
626
|
+
* "owner"
|
|
627
|
+
* ]
|
|
628
|
+
*/
|
|
629
|
+
slugs?: /**
|
|
630
|
+
* Slug of a role; for a role with id = 123:manager -> 123 is org_id & manager is slug
|
|
631
|
+
* example:
|
|
632
|
+
* owner
|
|
633
|
+
*/
|
|
634
|
+
Slug[];
|
|
635
|
+
/**
|
|
636
|
+
* Input to search across fields
|
|
637
|
+
* example:
|
|
638
|
+
* Administrator
|
|
639
|
+
*/
|
|
640
|
+
query?: string;
|
|
641
|
+
/**
|
|
642
|
+
* The Number of roles to return
|
|
643
|
+
* example:
|
|
644
|
+
* 1
|
|
645
|
+
*/
|
|
646
|
+
limit?: number;
|
|
647
|
+
/**
|
|
648
|
+
* The number of roles to skip before starting to collect the result set
|
|
649
|
+
* example:
|
|
650
|
+
* 1
|
|
651
|
+
*/
|
|
652
|
+
offset?: number;
|
|
653
|
+
}
|
|
654
|
+
/**
|
|
655
|
+
* A role that can be assigned to users in other organizations for sharing purposes.
|
|
656
|
+
*/
|
|
657
|
+
export interface ShareRole {
|
|
658
|
+
id: /**
|
|
659
|
+
* Format: <organization_id>:<slug>
|
|
660
|
+
* example:
|
|
661
|
+
* 123:owner
|
|
662
|
+
*/
|
|
663
|
+
RoleId;
|
|
664
|
+
/**
|
|
665
|
+
* Human-friendly name for the role
|
|
666
|
+
* example:
|
|
667
|
+
* Owner
|
|
668
|
+
*/
|
|
669
|
+
name: string;
|
|
670
|
+
/**
|
|
671
|
+
* URL-friendly name for the role
|
|
672
|
+
* example:
|
|
673
|
+
* owner
|
|
674
|
+
*/
|
|
675
|
+
slug: string;
|
|
676
|
+
/**
|
|
677
|
+
* Type of the role
|
|
678
|
+
*/
|
|
679
|
+
type: "share_role";
|
|
680
|
+
/**
|
|
681
|
+
* date and time then the role will expire
|
|
682
|
+
* example:
|
|
683
|
+
* 2028-07-21T17:32:28Z
|
|
684
|
+
*/
|
|
685
|
+
expires_at?: string; // date-time
|
|
686
|
+
organization_id: /**
|
|
687
|
+
* Id of an organization
|
|
688
|
+
* example:
|
|
689
|
+
* 123
|
|
690
|
+
*/
|
|
691
|
+
OrganizationId;
|
|
692
|
+
/**
|
|
693
|
+
* List of grants (permissions) applied to the role
|
|
694
|
+
*/
|
|
695
|
+
grants: Grant[];
|
|
696
|
+
}
|
|
697
|
+
/**
|
|
698
|
+
* Slug of a role; for a role with id = 123:manager -> 123 is org_id & manager is slug
|
|
699
|
+
* example:
|
|
700
|
+
* owner
|
|
701
|
+
*/
|
|
702
|
+
export type Slug = string;
|
|
703
|
+
/**
|
|
704
|
+
* Id of a user
|
|
705
|
+
* example:
|
|
706
|
+
* 1
|
|
707
|
+
*/
|
|
708
|
+
export type UserId = string;
|
|
709
|
+
/**
|
|
710
|
+
* A standard user role. Must be explicitly assigned to users.
|
|
711
|
+
*/
|
|
712
|
+
export interface UserRole {
|
|
713
|
+
id: /**
|
|
714
|
+
* Format: <organization_id>:<slug>
|
|
715
|
+
* example:
|
|
716
|
+
* 123:owner
|
|
717
|
+
*/
|
|
718
|
+
RoleId;
|
|
719
|
+
/**
|
|
720
|
+
* Human-friendly name for the role
|
|
721
|
+
* example:
|
|
722
|
+
* Owner
|
|
723
|
+
*/
|
|
724
|
+
name: string;
|
|
725
|
+
/**
|
|
726
|
+
* URL-friendly name for the role
|
|
727
|
+
* example:
|
|
728
|
+
* owner
|
|
729
|
+
*/
|
|
730
|
+
slug: string;
|
|
731
|
+
/**
|
|
732
|
+
* Type of the role
|
|
733
|
+
*/
|
|
734
|
+
type: "user_role";
|
|
735
|
+
/**
|
|
736
|
+
* date and time then the role will expire
|
|
737
|
+
* example:
|
|
738
|
+
* 2028-07-21T17:32:28Z
|
|
739
|
+
*/
|
|
740
|
+
expires_at?: string; // date-time
|
|
741
|
+
organization_id: /**
|
|
742
|
+
* Id of an organization
|
|
743
|
+
* example:
|
|
744
|
+
* 123
|
|
745
|
+
*/
|
|
746
|
+
OrganizationId;
|
|
747
|
+
/**
|
|
748
|
+
* List of grants (permissions) applied to the role
|
|
749
|
+
*/
|
|
750
|
+
grants: Grant[];
|
|
751
|
+
/**
|
|
752
|
+
* Optional parent role that this role inherits from. Must be an `org_role` or `share_role`.
|
|
753
|
+
* example:
|
|
754
|
+
* 123:owner
|
|
755
|
+
*/
|
|
756
|
+
parent_role?: string;
|
|
757
|
+
}
|
|
758
|
+
}
|
|
759
|
+
}
|
|
760
|
+
declare namespace Paths {
|
|
761
|
+
namespace AddAssignment {
|
|
762
|
+
namespace Parameters {
|
|
763
|
+
export type RoleId = /**
|
|
764
|
+
* Format: <organization_id>:<slug>
|
|
765
|
+
* example:
|
|
766
|
+
* 123:owner
|
|
767
|
+
*/
|
|
768
|
+
Components.Schemas.RoleId;
|
|
769
|
+
export type UserId = /**
|
|
770
|
+
* Id of a user
|
|
771
|
+
* example:
|
|
772
|
+
* 1
|
|
773
|
+
*/
|
|
774
|
+
Components.Schemas.UserId;
|
|
775
|
+
}
|
|
776
|
+
export interface PathParameters {
|
|
777
|
+
userId: Parameters.UserId;
|
|
778
|
+
roleId: Parameters.RoleId;
|
|
779
|
+
}
|
|
780
|
+
namespace Responses {
|
|
781
|
+
export type $201 = /* A role attached to an user */ Components.Schemas.Assignment;
|
|
782
|
+
}
|
|
783
|
+
}
|
|
784
|
+
namespace AssignRoles {
|
|
785
|
+
namespace Parameters {
|
|
786
|
+
export type UserId = /**
|
|
787
|
+
* Id of a user
|
|
788
|
+
* example:
|
|
789
|
+
* 1
|
|
790
|
+
*/
|
|
791
|
+
Components.Schemas.UserId;
|
|
792
|
+
}
|
|
793
|
+
export interface PathParameters {
|
|
794
|
+
userId: Parameters.UserId;
|
|
795
|
+
}
|
|
796
|
+
export type RequestBody = /* List of role ids attached to an user */ Components.Schemas.Assignments;
|
|
797
|
+
namespace Responses {
|
|
798
|
+
export type $200 = /* List of role ids attached to an user */ Components.Schemas.Assignments;
|
|
799
|
+
}
|
|
800
|
+
}
|
|
801
|
+
namespace CreateRole {
|
|
802
|
+
export type RequestBody = Components.Schemas.CreateRolePayload;
|
|
803
|
+
namespace Responses {
|
|
804
|
+
export type $200 = Components.Schemas.Role;
|
|
805
|
+
export type $400 = /* Error response */ Components.Schemas.Error;
|
|
806
|
+
export type $404 = /* Error response */ Components.Schemas.Error;
|
|
807
|
+
}
|
|
808
|
+
}
|
|
809
|
+
namespace DeleteRole {
|
|
810
|
+
namespace Parameters {
|
|
811
|
+
export type RoleId = /**
|
|
812
|
+
* Format: <organization_id>:<slug>
|
|
813
|
+
* example:
|
|
814
|
+
* 123:owner
|
|
815
|
+
*/
|
|
816
|
+
Components.Schemas.RoleId;
|
|
817
|
+
}
|
|
818
|
+
export interface PathParameters {
|
|
819
|
+
roleId: Parameters.RoleId;
|
|
820
|
+
}
|
|
821
|
+
namespace Responses {
|
|
822
|
+
export type $200 = Components.Schemas.Role;
|
|
823
|
+
}
|
|
824
|
+
}
|
|
825
|
+
namespace GetAssignedRolesForUser {
|
|
826
|
+
namespace Parameters {
|
|
827
|
+
export type UserId = /**
|
|
828
|
+
* Id of a user
|
|
829
|
+
* example:
|
|
830
|
+
* 1
|
|
831
|
+
*/
|
|
832
|
+
Components.Schemas.UserId;
|
|
833
|
+
}
|
|
834
|
+
export interface PathParameters {
|
|
835
|
+
userId: Parameters.UserId;
|
|
836
|
+
}
|
|
837
|
+
namespace Responses {
|
|
838
|
+
export type $200 = /* List of role ids attached to an user */ Components.Schemas.Assignments;
|
|
839
|
+
}
|
|
840
|
+
}
|
|
841
|
+
namespace GetRole {
|
|
842
|
+
namespace Parameters {
|
|
843
|
+
export type RoleId = /**
|
|
844
|
+
* Format: <organization_id>:<slug>
|
|
845
|
+
* example:
|
|
846
|
+
* 123:owner
|
|
847
|
+
*/
|
|
848
|
+
Components.Schemas.RoleId;
|
|
849
|
+
}
|
|
850
|
+
export interface PathParameters {
|
|
851
|
+
roleId: Parameters.RoleId;
|
|
852
|
+
}
|
|
853
|
+
namespace Responses {
|
|
854
|
+
export type $200 = Components.Schemas.Role;
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
namespace ListAllAssignments {
|
|
858
|
+
namespace Responses {
|
|
859
|
+
export interface $200 {
|
|
860
|
+
assignments?: /* A role attached to an user */ Components.Schemas.Assignment[];
|
|
861
|
+
}
|
|
862
|
+
}
|
|
863
|
+
}
|
|
864
|
+
namespace ListAllRoles {
|
|
865
|
+
namespace Responses {
|
|
866
|
+
export interface $200 {
|
|
867
|
+
roles?: Components.Schemas.Role[];
|
|
868
|
+
}
|
|
869
|
+
}
|
|
870
|
+
}
|
|
871
|
+
namespace ListCurrentRoles {
|
|
872
|
+
namespace Responses {
|
|
873
|
+
export interface $200 {
|
|
874
|
+
roles?: Components.Schemas.Role[];
|
|
875
|
+
}
|
|
876
|
+
}
|
|
877
|
+
}
|
|
878
|
+
namespace PutRole {
|
|
879
|
+
namespace Parameters {
|
|
880
|
+
export type RoleId = /**
|
|
881
|
+
* Format: <organization_id>:<slug>
|
|
882
|
+
* example:
|
|
883
|
+
* 123:owner
|
|
884
|
+
*/
|
|
885
|
+
Components.Schemas.RoleId;
|
|
886
|
+
}
|
|
887
|
+
export interface PathParameters {
|
|
888
|
+
roleId: Parameters.RoleId;
|
|
889
|
+
}
|
|
890
|
+
export type RequestBody = Components.Schemas.RolePayload;
|
|
891
|
+
namespace Responses {
|
|
892
|
+
export type $200 = Components.Schemas.Role;
|
|
893
|
+
export type $400 = /* Error response */ Components.Schemas.Error;
|
|
894
|
+
export type $404 = /* Error response */ Components.Schemas.Error;
|
|
895
|
+
}
|
|
896
|
+
}
|
|
897
|
+
namespace RefreshPermissions {
|
|
898
|
+
namespace Responses {
|
|
899
|
+
export interface $200 {
|
|
900
|
+
}
|
|
901
|
+
}
|
|
902
|
+
}
|
|
903
|
+
namespace RemoveAssignment {
|
|
904
|
+
namespace Parameters {
|
|
905
|
+
export type RoleId = /**
|
|
906
|
+
* Format: <organization_id>:<slug>
|
|
907
|
+
* example:
|
|
908
|
+
* 123:owner
|
|
909
|
+
*/
|
|
910
|
+
Components.Schemas.RoleId;
|
|
911
|
+
export type UserId = /**
|
|
912
|
+
* Id of a user
|
|
913
|
+
* example:
|
|
914
|
+
* 1
|
|
915
|
+
*/
|
|
916
|
+
Components.Schemas.UserId;
|
|
917
|
+
}
|
|
918
|
+
export interface PathParameters {
|
|
919
|
+
userId: Parameters.UserId;
|
|
920
|
+
roleId: Parameters.RoleId;
|
|
921
|
+
}
|
|
922
|
+
namespace Responses {
|
|
923
|
+
export type $200 = /* A role attached to an user */ Components.Schemas.Assignment;
|
|
924
|
+
}
|
|
925
|
+
}
|
|
926
|
+
namespace SearchRoles {
|
|
927
|
+
export type RequestBody = Components.Schemas.RoleSearchInput;
|
|
928
|
+
namespace Responses {
|
|
929
|
+
export interface $200 {
|
|
930
|
+
hits?: number;
|
|
931
|
+
results?: Components.Schemas.Role[];
|
|
932
|
+
}
|
|
933
|
+
}
|
|
934
|
+
}
|
|
935
|
+
}
|
|
936
|
+
|
|
937
|
+
interface OperationMethods {
|
|
938
|
+
/**
|
|
939
|
+
* listCurrentRoles - listCurrentRoles
|
|
940
|
+
*
|
|
941
|
+
* Returns roles and grants assigned to current user
|
|
942
|
+
*/
|
|
943
|
+
'listCurrentRoles'(
|
|
944
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
945
|
+
data?: any,
|
|
946
|
+
config?: AxiosRequestConfig
|
|
947
|
+
): OperationResponse<Paths.ListCurrentRoles.Responses.$200>
|
|
948
|
+
/**
|
|
949
|
+
* listAllRoles - listAllRoles
|
|
950
|
+
*
|
|
951
|
+
* Returns list of all roles in organization
|
|
952
|
+
*/
|
|
953
|
+
'listAllRoles'(
|
|
954
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
955
|
+
data?: any,
|
|
956
|
+
config?: AxiosRequestConfig
|
|
957
|
+
): OperationResponse<Paths.ListAllRoles.Responses.$200>
|
|
958
|
+
/**
|
|
959
|
+
* createRole - createRole
|
|
960
|
+
*
|
|
961
|
+
* Create role
|
|
962
|
+
*/
|
|
963
|
+
'createRole'(
|
|
964
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
965
|
+
data?: Paths.CreateRole.RequestBody,
|
|
966
|
+
config?: AxiosRequestConfig
|
|
967
|
+
): OperationResponse<Paths.CreateRole.Responses.$200>
|
|
968
|
+
/**
|
|
969
|
+
* searchRoles - searchRoles
|
|
970
|
+
*
|
|
971
|
+
* Search Roles
|
|
972
|
+
*/
|
|
973
|
+
'searchRoles'(
|
|
974
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
975
|
+
data?: Paths.SearchRoles.RequestBody,
|
|
976
|
+
config?: AxiosRequestConfig
|
|
977
|
+
): OperationResponse<Paths.SearchRoles.Responses.$200>
|
|
978
|
+
/**
|
|
979
|
+
* getRole - getRole
|
|
980
|
+
*
|
|
981
|
+
* Get role by id
|
|
982
|
+
*/
|
|
983
|
+
'getRole'(
|
|
984
|
+
parameters?: Parameters<Paths.GetRole.PathParameters> | null,
|
|
985
|
+
data?: any,
|
|
986
|
+
config?: AxiosRequestConfig
|
|
987
|
+
): OperationResponse<Paths.GetRole.Responses.$200>
|
|
988
|
+
/**
|
|
989
|
+
* putRole - putRole
|
|
990
|
+
*
|
|
991
|
+
* Create or update role
|
|
992
|
+
*/
|
|
993
|
+
'putRole'(
|
|
994
|
+
parameters?: Parameters<Paths.PutRole.PathParameters> | null,
|
|
995
|
+
data?: Paths.PutRole.RequestBody,
|
|
996
|
+
config?: AxiosRequestConfig
|
|
997
|
+
): OperationResponse<Paths.PutRole.Responses.$200>
|
|
998
|
+
/**
|
|
999
|
+
* deleteRole - deleteRole
|
|
1000
|
+
*
|
|
1001
|
+
* Delete role by id
|
|
1002
|
+
*/
|
|
1003
|
+
'deleteRole'(
|
|
1004
|
+
parameters?: Parameters<Paths.DeleteRole.PathParameters> | null,
|
|
1005
|
+
data?: any,
|
|
1006
|
+
config?: AxiosRequestConfig
|
|
1007
|
+
): OperationResponse<Paths.DeleteRole.Responses.$200>
|
|
1008
|
+
/**
|
|
1009
|
+
* refreshPermissions - refreshPermissions
|
|
1010
|
+
*
|
|
1011
|
+
* Makes sure the user has a role in the organization
|
|
1012
|
+
*/
|
|
1013
|
+
'refreshPermissions'(
|
|
1014
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1015
|
+
data?: any,
|
|
1016
|
+
config?: AxiosRequestConfig
|
|
1017
|
+
): OperationResponse<Paths.RefreshPermissions.Responses.$200>
|
|
1018
|
+
/**
|
|
1019
|
+
* getAssignedRolesForUser - getAssignedRolesForUser
|
|
1020
|
+
*
|
|
1021
|
+
* Get list of assigned roles by user id
|
|
1022
|
+
*/
|
|
1023
|
+
'getAssignedRolesForUser'(
|
|
1024
|
+
parameters?: Parameters<Paths.GetAssignedRolesForUser.PathParameters> | null,
|
|
1025
|
+
data?: any,
|
|
1026
|
+
config?: AxiosRequestConfig
|
|
1027
|
+
): OperationResponse<Paths.GetAssignedRolesForUser.Responses.$200>
|
|
1028
|
+
/**
|
|
1029
|
+
* assignRoles - assignRoles
|
|
1030
|
+
*
|
|
1031
|
+
* Assign / unassign roles to users.
|
|
1032
|
+
*/
|
|
1033
|
+
'assignRoles'(
|
|
1034
|
+
parameters?: Parameters<Paths.AssignRoles.PathParameters> | null,
|
|
1035
|
+
data?: Paths.AssignRoles.RequestBody,
|
|
1036
|
+
config?: AxiosRequestConfig
|
|
1037
|
+
): OperationResponse<Paths.AssignRoles.Responses.$200>
|
|
1038
|
+
/**
|
|
1039
|
+
* addAssignment - addAssignment
|
|
1040
|
+
*
|
|
1041
|
+
* Assign a user to a role.
|
|
1042
|
+
*
|
|
1043
|
+
* Use the `x-epilot-org-id` header to assign share roles to users in other orgs
|
|
1044
|
+
*
|
|
1045
|
+
*/
|
|
1046
|
+
'addAssignment'(
|
|
1047
|
+
parameters?: Parameters<Paths.AddAssignment.PathParameters> | null,
|
|
1048
|
+
data?: any,
|
|
1049
|
+
config?: AxiosRequestConfig
|
|
1050
|
+
): OperationResponse<Paths.AddAssignment.Responses.$201>
|
|
1051
|
+
/**
|
|
1052
|
+
* removeAssignment - removeAssignment
|
|
1053
|
+
*
|
|
1054
|
+
* Remove role assignment from user
|
|
1055
|
+
*/
|
|
1056
|
+
'removeAssignment'(
|
|
1057
|
+
parameters?: Parameters<Paths.RemoveAssignment.PathParameters> | null,
|
|
1058
|
+
data?: any,
|
|
1059
|
+
config?: AxiosRequestConfig
|
|
1060
|
+
): OperationResponse<Paths.RemoveAssignment.Responses.$200>
|
|
1061
|
+
/**
|
|
1062
|
+
* listAllAssignments - listAllAssignments
|
|
1063
|
+
*
|
|
1064
|
+
* Returns list of all assignments in organization
|
|
1065
|
+
*/
|
|
1066
|
+
'listAllAssignments'(
|
|
1067
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1068
|
+
data?: any,
|
|
1069
|
+
config?: AxiosRequestConfig
|
|
1070
|
+
): OperationResponse<Paths.ListAllAssignments.Responses.$200>
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
interface PathsDictionary {
|
|
1074
|
+
['/v1/permissions/me']: {
|
|
1075
|
+
/**
|
|
1076
|
+
* listCurrentRoles - listCurrentRoles
|
|
1077
|
+
*
|
|
1078
|
+
* Returns roles and grants assigned to current user
|
|
1079
|
+
*/
|
|
1080
|
+
'get'(
|
|
1081
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1082
|
+
data?: any,
|
|
1083
|
+
config?: AxiosRequestConfig
|
|
1084
|
+
): OperationResponse<Paths.ListCurrentRoles.Responses.$200>
|
|
1085
|
+
}
|
|
1086
|
+
['/v1/permissions/roles']: {
|
|
1087
|
+
/**
|
|
1088
|
+
* listAllRoles - listAllRoles
|
|
1089
|
+
*
|
|
1090
|
+
* Returns list of all roles in organization
|
|
1091
|
+
*/
|
|
1092
|
+
'get'(
|
|
1093
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1094
|
+
data?: any,
|
|
1095
|
+
config?: AxiosRequestConfig
|
|
1096
|
+
): OperationResponse<Paths.ListAllRoles.Responses.$200>
|
|
1097
|
+
/**
|
|
1098
|
+
* createRole - createRole
|
|
1099
|
+
*
|
|
1100
|
+
* Create role
|
|
1101
|
+
*/
|
|
1102
|
+
'post'(
|
|
1103
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1104
|
+
data?: Paths.CreateRole.RequestBody,
|
|
1105
|
+
config?: AxiosRequestConfig
|
|
1106
|
+
): OperationResponse<Paths.CreateRole.Responses.$200>
|
|
1107
|
+
}
|
|
1108
|
+
['/v1/permissions/roles:search']: {
|
|
1109
|
+
/**
|
|
1110
|
+
* searchRoles - searchRoles
|
|
1111
|
+
*
|
|
1112
|
+
* Search Roles
|
|
1113
|
+
*/
|
|
1114
|
+
'post'(
|
|
1115
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1116
|
+
data?: Paths.SearchRoles.RequestBody,
|
|
1117
|
+
config?: AxiosRequestConfig
|
|
1118
|
+
): OperationResponse<Paths.SearchRoles.Responses.$200>
|
|
1119
|
+
}
|
|
1120
|
+
['/v1/permissions/roles/{roleId}']: {
|
|
1121
|
+
/**
|
|
1122
|
+
* getRole - getRole
|
|
1123
|
+
*
|
|
1124
|
+
* Get role by id
|
|
1125
|
+
*/
|
|
1126
|
+
'get'(
|
|
1127
|
+
parameters?: Parameters<Paths.GetRole.PathParameters> | null,
|
|
1128
|
+
data?: any,
|
|
1129
|
+
config?: AxiosRequestConfig
|
|
1130
|
+
): OperationResponse<Paths.GetRole.Responses.$200>
|
|
1131
|
+
/**
|
|
1132
|
+
* putRole - putRole
|
|
1133
|
+
*
|
|
1134
|
+
* Create or update role
|
|
1135
|
+
*/
|
|
1136
|
+
'put'(
|
|
1137
|
+
parameters?: Parameters<Paths.PutRole.PathParameters> | null,
|
|
1138
|
+
data?: Paths.PutRole.RequestBody,
|
|
1139
|
+
config?: AxiosRequestConfig
|
|
1140
|
+
): OperationResponse<Paths.PutRole.Responses.$200>
|
|
1141
|
+
/**
|
|
1142
|
+
* deleteRole - deleteRole
|
|
1143
|
+
*
|
|
1144
|
+
* Delete role by id
|
|
1145
|
+
*/
|
|
1146
|
+
'delete'(
|
|
1147
|
+
parameters?: Parameters<Paths.DeleteRole.PathParameters> | null,
|
|
1148
|
+
data?: any,
|
|
1149
|
+
config?: AxiosRequestConfig
|
|
1150
|
+
): OperationResponse<Paths.DeleteRole.Responses.$200>
|
|
1151
|
+
}
|
|
1152
|
+
['/v1/permissions/refresh']: {
|
|
1153
|
+
/**
|
|
1154
|
+
* refreshPermissions - refreshPermissions
|
|
1155
|
+
*
|
|
1156
|
+
* Makes sure the user has a role in the organization
|
|
1157
|
+
*/
|
|
1158
|
+
'get'(
|
|
1159
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1160
|
+
data?: any,
|
|
1161
|
+
config?: AxiosRequestConfig
|
|
1162
|
+
): OperationResponse<Paths.RefreshPermissions.Responses.$200>
|
|
1163
|
+
}
|
|
1164
|
+
['/v1/permissions/assignments/{userId}']: {
|
|
1165
|
+
/**
|
|
1166
|
+
* getAssignedRolesForUser - getAssignedRolesForUser
|
|
1167
|
+
*
|
|
1168
|
+
* Get list of assigned roles by user id
|
|
1169
|
+
*/
|
|
1170
|
+
'get'(
|
|
1171
|
+
parameters?: Parameters<Paths.GetAssignedRolesForUser.PathParameters> | null,
|
|
1172
|
+
data?: any,
|
|
1173
|
+
config?: AxiosRequestConfig
|
|
1174
|
+
): OperationResponse<Paths.GetAssignedRolesForUser.Responses.$200>
|
|
1175
|
+
/**
|
|
1176
|
+
* assignRoles - assignRoles
|
|
1177
|
+
*
|
|
1178
|
+
* Assign / unassign roles to users.
|
|
1179
|
+
*/
|
|
1180
|
+
'put'(
|
|
1181
|
+
parameters?: Parameters<Paths.AssignRoles.PathParameters> | null,
|
|
1182
|
+
data?: Paths.AssignRoles.RequestBody,
|
|
1183
|
+
config?: AxiosRequestConfig
|
|
1184
|
+
): OperationResponse<Paths.AssignRoles.Responses.$200>
|
|
1185
|
+
}
|
|
1186
|
+
['/v1/permissions/assignments/{userId}/{roleId}']: {
|
|
1187
|
+
/**
|
|
1188
|
+
* addAssignment - addAssignment
|
|
1189
|
+
*
|
|
1190
|
+
* Assign a user to a role.
|
|
1191
|
+
*
|
|
1192
|
+
* Use the `x-epilot-org-id` header to assign share roles to users in other orgs
|
|
1193
|
+
*
|
|
1194
|
+
*/
|
|
1195
|
+
'post'(
|
|
1196
|
+
parameters?: Parameters<Paths.AddAssignment.PathParameters> | null,
|
|
1197
|
+
data?: any,
|
|
1198
|
+
config?: AxiosRequestConfig
|
|
1199
|
+
): OperationResponse<Paths.AddAssignment.Responses.$201>
|
|
1200
|
+
/**
|
|
1201
|
+
* removeAssignment - removeAssignment
|
|
1202
|
+
*
|
|
1203
|
+
* Remove role assignment from user
|
|
1204
|
+
*/
|
|
1205
|
+
'delete'(
|
|
1206
|
+
parameters?: Parameters<Paths.RemoveAssignment.PathParameters> | null,
|
|
1207
|
+
data?: any,
|
|
1208
|
+
config?: AxiosRequestConfig
|
|
1209
|
+
): OperationResponse<Paths.RemoveAssignment.Responses.$200>
|
|
1210
|
+
}
|
|
1211
|
+
['/v1/permissions/assignments']: {
|
|
1212
|
+
/**
|
|
1213
|
+
* listAllAssignments - listAllAssignments
|
|
1214
|
+
*
|
|
1215
|
+
* Returns list of all assignments in organization
|
|
1216
|
+
*/
|
|
1217
|
+
'get'(
|
|
1218
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1219
|
+
data?: any,
|
|
1220
|
+
config?: AxiosRequestConfig
|
|
1221
|
+
): OperationResponse<Paths.ListAllAssignments.Responses.$200>
|
|
1222
|
+
}
|
|
1223
|
+
}
|
|
1224
|
+
|
|
1225
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
1226
|
+
|
|
1227
|
+
type Assignment = Components.Schemas.Assignment;
|
|
1228
|
+
type Assignments = Components.Schemas.Assignments;
|
|
1229
|
+
type BaseRole = Components.Schemas.BaseRole;
|
|
1230
|
+
type BaseRoleForCreate = Components.Schemas.BaseRoleForCreate;
|
|
1231
|
+
type CreateRolePayload = Components.Schemas.CreateRolePayload;
|
|
1232
|
+
type EqualsCondition = Components.Schemas.EqualsCondition;
|
|
1233
|
+
type Error = Components.Schemas.Error;
|
|
1234
|
+
type Grant = Components.Schemas.Grant;
|
|
1235
|
+
type GrantCondition = Components.Schemas.GrantCondition;
|
|
1236
|
+
type GrantWithDependencies = Components.Schemas.GrantWithDependencies;
|
|
1237
|
+
type InternalAssignment = Components.Schemas.InternalAssignment;
|
|
1238
|
+
type OrgAssignments = Components.Schemas.OrgAssignments;
|
|
1239
|
+
type OrgRole = Components.Schemas.OrgRole;
|
|
1240
|
+
type OrgRoles = Components.Schemas.OrgRoles;
|
|
1241
|
+
type OrganizationId = Components.Schemas.OrganizationId;
|
|
1242
|
+
type PartnerRole = Components.Schemas.PartnerRole;
|
|
1243
|
+
type PortalRole = Components.Schemas.PortalRole;
|
|
1244
|
+
type Role = Components.Schemas.Role;
|
|
1245
|
+
type RoleId = Components.Schemas.RoleId;
|
|
1246
|
+
type RolePayload = Components.Schemas.RolePayload;
|
|
1247
|
+
type RoleSearchInput = Components.Schemas.RoleSearchInput;
|
|
1248
|
+
type ShareRole = Components.Schemas.ShareRole;
|
|
1249
|
+
type Slug = Components.Schemas.Slug;
|
|
1250
|
+
type UserId = Components.Schemas.UserId;
|
|
1251
|
+
type UserRole = Components.Schemas.UserRole;
|
|
1252
|
+
|
|
1253
|
+
export type { Assignment as A, BaseRole as B, Client as C, EqualsCondition as E, Grant as G, InternalAssignment as I, OperationMethods as O, PathsDictionary as P, Role as R, ShareRole as S, UserId as U, Assignments as a, BaseRoleForCreate as b, CreateRolePayload as c, Error as d, GrantCondition as e, GrantWithDependencies as f, OrgAssignments as g, OrgRole as h, OrgRoles as i, OrganizationId as j, PartnerRole as k, PortalRole as l, RoleId as m, RolePayload as n, RoleSearchInput as o, Slug as p, UserRole as q };
|