@epilot/sdk 2.1.0-rc.0 → 2.1.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/definitions/app.json +38 -0
- package/definitions/automation.json +2 -37
- package/definitions/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +115 -1
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +279 -42
- package/definitions/data-management.json +10 -0
- package/definitions/email-template.json +25 -3
- package/definitions/entity.json +205 -3
- package/definitions/erp-integration-runtime.json +1 -1
- package/definitions/erp-integration.json +472 -13
- package/definitions/journey.json +257 -12
- package/definitions/kanban.json +630 -78
- package/definitions/organization-runtime.json +1 -1
- package/definitions/organization.json +614 -51
- package/definitions/workflow.json +40 -0
- package/dist/README-VG67PX4R.js +7 -0
- package/dist/README-W4B35MRN.cjs +7 -0
- package/dist/_index-AMVZBT2K.cjs +99 -0
- package/dist/_index-S6LFD3ER.js +99 -0
- package/dist/access-token-6BJDZSFE.cjs +7 -0
- package/dist/access-token-GSQZLDXR.js +7 -0
- package/dist/address-HA4RMRNQ.cjs +7 -0
- package/dist/address-QVJUGMOG.js +7 -0
- package/dist/address-suggestions-74244BAJ.js +7 -0
- package/dist/address-suggestions-IUQMYF27.cjs +7 -0
- package/dist/ai-agents-IZWFEUSH.js +7 -0
- package/dist/ai-agents-PWHKNRCX.cjs +7 -0
- package/dist/apis/access-token.cjs +10 -13
- package/dist/apis/access-token.js +7 -10
- package/dist/apis/address-suggestions.cjs +10 -13
- package/dist/apis/address-suggestions.js +7 -10
- package/dist/apis/address.cjs +10 -13
- package/dist/apis/address.js +7 -10
- package/dist/apis/ai-agents.cjs +10 -13
- package/dist/apis/ai-agents.js +7 -10
- package/dist/apis/app.cjs +10 -13
- package/dist/apis/app.js +7 -10
- package/dist/apis/audit-logs.cjs +10 -13
- package/dist/apis/audit-logs.js +7 -10
- package/dist/apis/automation.cjs +10 -13
- package/dist/apis/automation.js +7 -10
- package/dist/apis/billing.cjs +10 -13
- package/dist/apis/billing.js +7 -10
- package/dist/apis/blueprint-manifest.cjs +10 -13
- package/dist/apis/blueprint-manifest.js +7 -10
- package/dist/apis/consent.cjs +10 -13
- package/dist/apis/consent.js +7 -10
- package/dist/apis/customer-portal.cjs +10 -13
- package/dist/apis/customer-portal.js +7 -10
- package/dist/apis/dashboard.cjs +10 -13
- package/dist/apis/dashboard.js +7 -10
- package/dist/apis/data-management.cjs +10 -13
- package/dist/apis/data-management.js +7 -10
- package/dist/apis/deduplication.cjs +10 -13
- package/dist/apis/deduplication.js +7 -10
- package/dist/apis/design.cjs +10 -13
- package/dist/apis/design.js +7 -10
- package/dist/apis/document.cjs +10 -13
- package/dist/apis/document.js +7 -10
- package/dist/apis/email-settings.cjs +10 -13
- package/dist/apis/email-settings.js +7 -10
- package/dist/apis/email-template.cjs +10 -13
- package/dist/apis/email-template.js +7 -10
- package/dist/apis/entity-mapping.cjs +10 -13
- package/dist/apis/entity-mapping.js +7 -10
- package/dist/apis/entity.cjs +10 -13
- package/dist/apis/entity.js +7 -10
- package/dist/apis/environments.cjs +10 -13
- package/dist/apis/environments.js +7 -10
- package/dist/apis/erp-integration.cjs +10 -13
- package/dist/apis/erp-integration.js +7 -10
- package/dist/apis/event-catalog.cjs +10 -13
- package/dist/apis/event-catalog.js +7 -10
- package/dist/apis/file.cjs +10 -13
- package/dist/apis/file.js +7 -10
- package/dist/apis/iban.cjs +10 -13
- package/dist/apis/iban.js +7 -10
- package/dist/apis/journey.cjs +10 -13
- package/dist/apis/journey.js +7 -10
- package/dist/apis/kanban.cjs +10 -13
- package/dist/apis/kanban.js +7 -10
- package/dist/apis/message.cjs +10 -13
- package/dist/apis/message.js +7 -10
- package/dist/apis/metering.cjs +10 -13
- package/dist/apis/metering.js +7 -10
- package/dist/apis/notes.cjs +10 -13
- package/dist/apis/notes.js +7 -10
- package/dist/apis/notification.cjs +10 -13
- package/dist/apis/notification.js +7 -10
- package/dist/apis/organization.cjs +10 -13
- package/dist/apis/organization.d.cts +2 -2
- package/dist/apis/organization.d.ts +2 -2
- package/dist/apis/organization.js +7 -10
- package/dist/apis/partner-directory.cjs +10 -13
- package/dist/apis/partner-directory.js +7 -10
- package/dist/apis/permissions.cjs +10 -13
- package/dist/apis/permissions.js +7 -10
- package/dist/apis/pricing-tier.cjs +10 -13
- package/dist/apis/pricing-tier.js +7 -10
- package/dist/apis/pricing.cjs +10 -13
- package/dist/apis/pricing.js +7 -10
- package/dist/apis/purpose.cjs +10 -13
- package/dist/apis/purpose.js +7 -10
- package/dist/apis/sandbox.cjs +10 -13
- package/dist/apis/sandbox.js +7 -10
- package/dist/apis/submission.cjs +10 -13
- package/dist/apis/submission.js +7 -10
- package/dist/apis/targeting.cjs +10 -13
- package/dist/apis/targeting.js +7 -10
- package/dist/apis/template-variables.cjs +10 -13
- package/dist/apis/template-variables.js +7 -10
- package/dist/apis/user.cjs +10 -13
- package/dist/apis/user.js +7 -10
- package/dist/apis/validation-rules.cjs +10 -13
- package/dist/apis/validation-rules.js +7 -10
- package/dist/apis/webhooks.cjs +10 -13
- package/dist/apis/webhooks.js +7 -10
- package/dist/apis/workflow-definition.cjs +10 -13
- package/dist/apis/workflow-definition.js +7 -10
- package/dist/apis/workflow.cjs +10 -13
- package/dist/apis/workflow.js +7 -10
- package/dist/app-IKHWU222.cjs +7 -0
- package/dist/app-VLM3SWKA.js +7 -0
- package/dist/audit-logs-5VXHOQ7S.js +7 -0
- package/dist/audit-logs-D2LFUA2R.cjs +7 -0
- package/dist/automation-3HGCK725.cjs +7 -0
- package/dist/automation-72VGEJCY.js +7 -0
- package/dist/billing-DUWDISHP.cjs +7 -0
- package/dist/billing-IPALEAG2.js +7 -0
- package/dist/blueprint-manifest-CXSCRQ5X.js +7 -0
- package/dist/blueprint-manifest-SHNZPK5O.cjs +7 -0
- package/dist/chunk-2HOJWFQ4.js +14 -0
- package/dist/chunk-372VUPHN.js +14 -0
- package/dist/chunk-3HJEWWPS.cjs +14 -0
- package/dist/chunk-3N67SSL3.js +14 -0
- package/dist/chunk-3XEP56SV.cjs +204 -0
- package/dist/chunk-3ZZ57K3S.cjs +14 -0
- package/dist/chunk-4SWC43JO.cjs +14 -0
- package/dist/chunk-4VFQTSJQ.js +14 -0
- package/dist/chunk-57QIBYDN.js +14 -0
- package/dist/chunk-5SNJAD6F.cjs +14 -0
- package/dist/chunk-73H6TVKN.js +14 -0
- package/dist/chunk-A6JOROUC.cjs +14 -0
- package/dist/chunk-AJKH25H2.cjs +14 -0
- package/dist/chunk-ARWMTXJV.cjs +14 -0
- package/dist/chunk-B3ZGAG7B.js +14 -0
- package/dist/chunk-BH5ZXK4J.cjs +14 -0
- package/dist/chunk-BWFXLUK5.cjs +14 -0
- package/dist/chunk-C6UTZEHH.js +14 -0
- package/dist/chunk-CPKBR34V.js +14 -0
- package/dist/chunk-CWSHYFVZ.js +14 -0
- package/dist/chunk-DJKSULPK.js +14 -0
- package/dist/chunk-DNJ54L2G.js +14 -0
- package/dist/chunk-DY2D2IW5.cjs +14 -0
- package/dist/chunk-E26ZO7QM.cjs +14 -0
- package/dist/chunk-EBCHCYUO.js +14 -0
- package/dist/chunk-EPAIOB5U.cjs +14 -0
- package/dist/chunk-EQZMT2HF.cjs +14 -0
- package/dist/chunk-F376L6PP.cjs +14 -0
- package/dist/chunk-F472YLJG.cjs +14 -0
- package/dist/chunk-FXOX3X7E.cjs +14 -0
- package/dist/chunk-G2REP2VZ.cjs +14 -0
- package/dist/chunk-GLO477NZ.js +14 -0
- package/dist/chunk-H4VSK4KF.js +14 -0
- package/dist/chunk-HPSGM6QP.js +14 -0
- package/dist/chunk-HPYHWTTA.cjs +14 -0
- package/dist/chunk-IH4CMOML.js +14 -0
- package/dist/chunk-IMT3IE5M.cjs +14 -0
- package/dist/chunk-IP2WWEOU.js +14 -0
- package/dist/chunk-IS2VB342.js +14 -0
- package/dist/chunk-ITX53XAZ.js +14 -0
- package/dist/chunk-JXBXDTFG.cjs +14 -0
- package/dist/chunk-K62XK7KU.js +14 -0
- package/dist/chunk-KA3TGFJP.js +14 -0
- package/dist/chunk-KBOVBUBM.js +14 -0
- package/dist/chunk-KPGC2D6E.js +14 -0
- package/dist/chunk-KSXTBGIV.js +14 -0
- package/dist/chunk-LCIJ4TJ4.cjs +14 -0
- package/dist/chunk-LQOLYXGQ.cjs +14 -0
- package/dist/chunk-LSIWCIQV.js +14 -0
- package/dist/chunk-MHNSZ4HE.js +14 -0
- package/dist/chunk-MKX4CKAB.cjs +14 -0
- package/dist/chunk-MRTAFRO7.js +14 -0
- package/dist/chunk-MRZ7LGKZ.js +14 -0
- package/dist/chunk-MSASBR2Y.js +14 -0
- package/dist/chunk-NAWLLC3T.cjs +14 -0
- package/dist/chunk-NJK5F5TF.cjs +21 -0
- package/dist/chunk-NLSZVGHK.cjs +14 -0
- package/dist/chunk-O4LRVGOY.js +14 -0
- package/dist/chunk-OG2DMGU6.cjs +14 -0
- package/dist/chunk-OGQKJTXF.js +14 -0
- package/dist/chunk-PETLAONH.js +14 -0
- package/dist/chunk-PVSS2WPM.cjs +14 -0
- package/dist/chunk-PXITFTJA.cjs +14 -0
- package/dist/chunk-QDVPPRWI.cjs +14 -0
- package/dist/chunk-QKERXNJJ.cjs +14 -0
- package/dist/chunk-QLML3IP5.cjs +14 -0
- package/dist/chunk-QVAJ5JP4.js +14 -0
- package/dist/chunk-RD7E4OSJ.cjs +14 -0
- package/dist/chunk-RWSA3LXE.cjs +14 -0
- package/dist/chunk-RXSS67VI.cjs +14 -0
- package/dist/chunk-S3ZNESMC.cjs +14 -0
- package/dist/chunk-S7NDMDRX.js +14 -0
- package/dist/chunk-SK3VYIZ6.cjs +14 -0
- package/dist/chunk-SMGHAG5C.cjs +14 -0
- package/dist/chunk-T46LODOF.js +14 -0
- package/dist/chunk-TIJWJVKZ.js +14 -0
- package/dist/chunk-TLWCYLNA.js +14 -0
- package/dist/chunk-TRJLYZHD.js +14 -0
- package/dist/chunk-UKKJMCNH.js +14 -0
- package/dist/chunk-ULBEEHG4.js +204 -0
- package/dist/chunk-VGTUK3QD.cjs +14 -0
- package/dist/chunk-VQ7R36AC.js +14 -0
- package/dist/chunk-VVQB5W7U.cjs +14 -0
- package/dist/chunk-VVVATFGK.cjs +14 -0
- package/dist/chunk-WMTYO5OX.cjs +14 -0
- package/dist/chunk-WOSSSFXB.js +14 -0
- package/dist/chunk-WOXXNKTE.js +14 -0
- package/dist/chunk-XKI2OAYV.cjs +14 -0
- package/dist/chunk-XR4QF6KQ.cjs +14 -0
- package/dist/chunk-XYHTQ523.cjs +14 -0
- package/dist/chunk-XZYZLSUO.cjs +14 -0
- package/dist/chunk-YPSWSI3M.js +21 -0
- package/dist/chunk-YYBIU5BQ.js +14 -0
- package/dist/chunk-YZA5WZUS.js +14 -0
- package/dist/chunk-Z4LUE424.cjs +14 -0
- package/dist/chunk-ZV6XYUXS.js +14 -0
- package/dist/consent-CS2ZBZX4.cjs +7 -0
- package/dist/consent-NNYHF2N4.js +7 -0
- package/dist/customer-portal-D3SLPAHZ.js +7 -0
- package/dist/customer-portal-UR3GN4VU.cjs +7 -0
- package/dist/dashboard-UHYR5RTY.cjs +7 -0
- package/dist/dashboard-UTPGXFW5.js +7 -0
- package/dist/data-management-QH2IJ5QV.js +7 -0
- package/dist/data-management-TEFRLGSU.cjs +7 -0
- package/dist/deduplication-ECVAZVVA.cjs +7 -0
- package/dist/deduplication-GYIST22B.js +7 -0
- package/dist/design-KUVXMFFK.cjs +7 -0
- package/dist/design-YKBXRW5C.js +7 -0
- package/dist/document-CY2A2OE7.js +7 -0
- package/dist/document-RYQ7MF6U.cjs +7 -0
- package/dist/email-settings-TQ5GGDYG.js +7 -0
- package/dist/email-settings-TQC34GST.cjs +7 -0
- package/dist/email-template-M2VVL4TI.cjs +7 -0
- package/dist/email-template-WYROV3UG.js +7 -0
- package/dist/entity-FA6PZX6S.js +7 -0
- package/dist/entity-IX5NSHPX.cjs +7 -0
- package/dist/entity-mapping-7J3IAGKQ.js +7 -0
- package/dist/entity-mapping-ZNMFCUKK.cjs +7 -0
- package/dist/environments-E3X6NYGX.js +7 -0
- package/dist/environments-P2JS4F5N.cjs +7 -0
- package/dist/erp-integration-EP2XFEH5.js +7 -0
- package/dist/erp-integration-NNV72VFI.cjs +7 -0
- package/dist/event-catalog-C45ISVMP.cjs +7 -0
- package/dist/event-catalog-D7VJ7WRS.js +7 -0
- package/dist/file-UOWBTDIU.cjs +7 -0
- package/dist/file-XSN3NAVZ.js +7 -0
- package/dist/iban-24GHLFDB.cjs +7 -0
- package/dist/iban-LDKYDVQV.js +7 -0
- package/dist/index.cjs +199 -58
- package/dist/index.d.cts +17 -2
- package/dist/index.d.ts +17 -2
- package/dist/index.js +197 -56
- package/dist/journey-7CKX67M7.js +7 -0
- package/dist/journey-EUZ6MVHG.cjs +7 -0
- package/dist/kanban-CHTH2ZSY.cjs +7 -0
- package/dist/kanban-HI6LL5WY.js +7 -0
- package/dist/message-3XZLJR6R.cjs +7 -0
- package/dist/message-ZNMCS5YH.js +7 -0
- package/dist/metering-DZNZPPY6.cjs +7 -0
- package/dist/metering-KOSCPPKB.js +7 -0
- package/dist/notes-3AO5GXIT.js +7 -0
- package/dist/notes-MPWOQC5J.cjs +7 -0
- package/dist/notification-PZOCUYD5.cjs +7 -0
- package/dist/notification-VWDZRSFZ.js +7 -0
- package/dist/organization-RARYYG2E.cjs +7 -0
- package/dist/organization-ZERPH2IH.js +7 -0
- package/dist/{organization.d-Bd2Hmk8v.d.cts → organization.d-DqwnNxMg.d.cts} +34 -7
- package/dist/{organization.d-Bd2Hmk8v.d.ts → organization.d-DqwnNxMg.d.ts} +34 -7
- package/dist/partner-directory-2XMPQWWX.js +7 -0
- package/dist/partner-directory-WHNTKQ5E.cjs +7 -0
- package/dist/permissions-4T3GFNB4.js +7 -0
- package/dist/permissions-FGBIJNN7.cjs +7 -0
- package/dist/pricing-4Z4TOETA.cjs +7 -0
- package/dist/pricing-C65DTZSX.js +7 -0
- package/dist/pricing-tier-NI35WOUP.cjs +7 -0
- package/dist/pricing-tier-VUOFK5Q7.js +7 -0
- package/dist/purpose-AKOEUHZ4.cjs +7 -0
- package/dist/purpose-RBRV3AQZ.js +7 -0
- package/dist/sandbox-2KN4X66E.cjs +7 -0
- package/dist/sandbox-L2SOOGGR.js +7 -0
- package/dist/submission-7BISSPO6.js +7 -0
- package/dist/submission-Q24BU4GS.cjs +7 -0
- package/dist/targeting-EYGYZD6M.cjs +7 -0
- package/dist/targeting-GEJTJN5Z.js +7 -0
- package/dist/template-variables-OAYS2E3G.cjs +1148 -0
- package/dist/template-variables-VKDJJZUT.js +1148 -0
- package/dist/user-EIEOI3OG.js +7 -0
- package/dist/user-NJJ7XVKB.cjs +7 -0
- package/dist/validation-rules-P6F5P73P.js +7 -0
- package/dist/validation-rules-VDU3CIZV.cjs +7 -0
- package/dist/webhooks-I7JWU34X.cjs +7 -0
- package/dist/webhooks-WPLEHVPX.js +7 -0
- package/dist/workflow-3LLURW3H.js +7 -0
- package/dist/workflow-RAGQDYXT.cjs +7 -0
- package/dist/workflow-definition-B6ELOZUR.cjs +7 -0
- package/dist/workflow-definition-D24CRCK2.js +7 -0
- package/docs/access-token.md +440 -0
- package/docs/address-suggestions.md +256 -0
- package/docs/address.md +284 -0
- package/docs/ai-agents.md +1891 -0
- package/docs/app.md +3388 -0
- package/docs/audit-logs.md +242 -0
- package/docs/automation.md +4044 -0
- package/docs/billing.md +783 -0
- package/docs/blueprint-manifest.md +3234 -0
- package/docs/consent.md +213 -0
- package/docs/customer-portal.md +11399 -0
- package/docs/dashboard.md +640 -0
- package/docs/data-management.md +883 -0
- package/docs/deduplication.md +135 -0
- package/docs/design.md +1273 -0
- package/docs/document.md +590 -0
- package/docs/email-settings.md +1544 -0
- package/docs/email-template.md +1197 -0
- package/docs/entity-mapping.md +2864 -0
- package/docs/entity.md +9595 -0
- package/docs/environments.md +259 -0
- package/docs/erp-integration.md +4572 -0
- package/docs/event-catalog.md +835 -0
- package/docs/file.md +1453 -0
- package/docs/iban.md +61 -0
- package/docs/journey.md +2268 -0
- package/docs/kanban.md +882 -0
- package/docs/message.md +2122 -0
- package/docs/metering.md +1431 -0
- package/docs/notes.md +670 -0
- package/docs/notification.md +1207 -0
- package/docs/organization.md +733 -0
- package/docs/partner-directory.md +1197 -0
- package/docs/permissions.md +1047 -0
- package/docs/pricing-tier.md +81 -0
- package/docs/pricing.md +5923 -0
- package/docs/purpose.md +283 -0
- package/docs/sandbox.md +389 -0
- package/docs/submission.md +195 -0
- package/docs/targeting.md +959 -0
- package/docs/template-variables.md +1141 -0
- package/docs/user.md +2555 -0
- package/docs/validation-rules.md +1597 -0
- package/docs/webhooks.md +996 -0
- package/docs/workflow-definition.md +3842 -0
- package/docs/workflow.md +4465 -0
- package/package.json +3 -2
- package/dist/chunk-XE25WERA.js +0 -125
- package/dist/chunk-XEQMAKGA.cjs +0 -125
|
@@ -844,6 +844,13 @@ declare namespace Paths {
|
|
|
844
844
|
}
|
|
845
845
|
}
|
|
846
846
|
}
|
|
847
|
+
namespace GetOrganizationFeatureSettings {
|
|
848
|
+
namespace Responses {
|
|
849
|
+
export type $200 = /* Feature settings metadata served to frontend applications. */ Components.Schemas.FeatureSettings;
|
|
850
|
+
export interface $401 {
|
|
851
|
+
}
|
|
852
|
+
}
|
|
853
|
+
}
|
|
847
854
|
namespace GetSettings {
|
|
848
855
|
namespace Parameters {
|
|
849
856
|
export type OrgId = /**
|
|
@@ -1073,15 +1080,24 @@ interface OperationMethods {
|
|
|
1073
1080
|
config?: AxiosRequestConfig
|
|
1074
1081
|
): OperationResponse<Paths.DeleteSettingsValue.Responses.$200>
|
|
1075
1082
|
/**
|
|
1076
|
-
*
|
|
1083
|
+
* getOrganizationFeatureSettings - Get organization feature settings
|
|
1077
1084
|
*
|
|
1078
|
-
* Returns
|
|
1079
|
-
* resource type mappings, and error code severities.
|
|
1085
|
+
* Returns feature flag metadata for the organization UI.
|
|
1080
1086
|
*
|
|
1081
1087
|
* This data is static (identical for all organizations) and changes infrequently.
|
|
1082
1088
|
* Clients should cache responses using the Cache-Control header.
|
|
1083
1089
|
*
|
|
1084
1090
|
*/
|
|
1091
|
+
'getOrganizationFeatureSettings'(
|
|
1092
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1093
|
+
data?: any,
|
|
1094
|
+
config?: AxiosRequestConfig
|
|
1095
|
+
): OperationResponse<Paths.GetOrganizationFeatureSettings.Responses.$200>
|
|
1096
|
+
/**
|
|
1097
|
+
* getFeatureSettings - Get platform configuration metadata
|
|
1098
|
+
*
|
|
1099
|
+
* Deprecated: use /v2/organization/feature-settings instead.
|
|
1100
|
+
*/
|
|
1085
1101
|
'getFeatureSettings'(
|
|
1086
1102
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1087
1103
|
data?: any,
|
|
@@ -1200,12 +1216,11 @@ interface PathsDictionary {
|
|
|
1200
1216
|
config?: AxiosRequestConfig
|
|
1201
1217
|
): OperationResponse<Paths.DeleteSettingsValue.Responses.$200>
|
|
1202
1218
|
}
|
|
1203
|
-
['/v2/feature-settings']: {
|
|
1219
|
+
['/v2/organization/feature-settings']: {
|
|
1204
1220
|
/**
|
|
1205
|
-
*
|
|
1221
|
+
* getOrganizationFeatureSettings - Get organization feature settings
|
|
1206
1222
|
*
|
|
1207
|
-
* Returns
|
|
1208
|
-
* resource type mappings, and error code severities.
|
|
1223
|
+
* Returns feature flag metadata for the organization UI.
|
|
1209
1224
|
*
|
|
1210
1225
|
* This data is static (identical for all organizations) and changes infrequently.
|
|
1211
1226
|
* Clients should cache responses using the Cache-Control header.
|
|
@@ -1215,6 +1230,18 @@ interface PathsDictionary {
|
|
|
1215
1230
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1216
1231
|
data?: any,
|
|
1217
1232
|
config?: AxiosRequestConfig
|
|
1233
|
+
): OperationResponse<Paths.GetOrganizationFeatureSettings.Responses.$200>
|
|
1234
|
+
}
|
|
1235
|
+
['/v2/feature-settings']: {
|
|
1236
|
+
/**
|
|
1237
|
+
* getFeatureSettings - Get platform configuration metadata
|
|
1238
|
+
*
|
|
1239
|
+
* Deprecated: use /v2/organization/feature-settings instead.
|
|
1240
|
+
*/
|
|
1241
|
+
'get'(
|
|
1242
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1243
|
+
data?: any,
|
|
1244
|
+
config?: AxiosRequestConfig
|
|
1218
1245
|
): OperationResponse<Paths.GetFeatureSettings.Responses.$200>
|
|
1219
1246
|
}
|
|
1220
1247
|
}
|
|
@@ -844,6 +844,13 @@ declare namespace Paths {
|
|
|
844
844
|
}
|
|
845
845
|
}
|
|
846
846
|
}
|
|
847
|
+
namespace GetOrganizationFeatureSettings {
|
|
848
|
+
namespace Responses {
|
|
849
|
+
export type $200 = /* Feature settings metadata served to frontend applications. */ Components.Schemas.FeatureSettings;
|
|
850
|
+
export interface $401 {
|
|
851
|
+
}
|
|
852
|
+
}
|
|
853
|
+
}
|
|
847
854
|
namespace GetSettings {
|
|
848
855
|
namespace Parameters {
|
|
849
856
|
export type OrgId = /**
|
|
@@ -1073,15 +1080,24 @@ interface OperationMethods {
|
|
|
1073
1080
|
config?: AxiosRequestConfig
|
|
1074
1081
|
): OperationResponse<Paths.DeleteSettingsValue.Responses.$200>
|
|
1075
1082
|
/**
|
|
1076
|
-
*
|
|
1083
|
+
* getOrganizationFeatureSettings - Get organization feature settings
|
|
1077
1084
|
*
|
|
1078
|
-
* Returns
|
|
1079
|
-
* resource type mappings, and error code severities.
|
|
1085
|
+
* Returns feature flag metadata for the organization UI.
|
|
1080
1086
|
*
|
|
1081
1087
|
* This data is static (identical for all organizations) and changes infrequently.
|
|
1082
1088
|
* Clients should cache responses using the Cache-Control header.
|
|
1083
1089
|
*
|
|
1084
1090
|
*/
|
|
1091
|
+
'getOrganizationFeatureSettings'(
|
|
1092
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1093
|
+
data?: any,
|
|
1094
|
+
config?: AxiosRequestConfig
|
|
1095
|
+
): OperationResponse<Paths.GetOrganizationFeatureSettings.Responses.$200>
|
|
1096
|
+
/**
|
|
1097
|
+
* getFeatureSettings - Get platform configuration metadata
|
|
1098
|
+
*
|
|
1099
|
+
* Deprecated: use /v2/organization/feature-settings instead.
|
|
1100
|
+
*/
|
|
1085
1101
|
'getFeatureSettings'(
|
|
1086
1102
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1087
1103
|
data?: any,
|
|
@@ -1200,12 +1216,11 @@ interface PathsDictionary {
|
|
|
1200
1216
|
config?: AxiosRequestConfig
|
|
1201
1217
|
): OperationResponse<Paths.DeleteSettingsValue.Responses.$200>
|
|
1202
1218
|
}
|
|
1203
|
-
['/v2/feature-settings']: {
|
|
1219
|
+
['/v2/organization/feature-settings']: {
|
|
1204
1220
|
/**
|
|
1205
|
-
*
|
|
1221
|
+
* getOrganizationFeatureSettings - Get organization feature settings
|
|
1206
1222
|
*
|
|
1207
|
-
* Returns
|
|
1208
|
-
* resource type mappings, and error code severities.
|
|
1223
|
+
* Returns feature flag metadata for the organization UI.
|
|
1209
1224
|
*
|
|
1210
1225
|
* This data is static (identical for all organizations) and changes infrequently.
|
|
1211
1226
|
* Clients should cache responses using the Cache-Control header.
|
|
@@ -1215,6 +1230,18 @@ interface PathsDictionary {
|
|
|
1215
1230
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1216
1231
|
data?: any,
|
|
1217
1232
|
config?: AxiosRequestConfig
|
|
1233
|
+
): OperationResponse<Paths.GetOrganizationFeatureSettings.Responses.$200>
|
|
1234
|
+
}
|
|
1235
|
+
['/v2/feature-settings']: {
|
|
1236
|
+
/**
|
|
1237
|
+
* getFeatureSettings - Get platform configuration metadata
|
|
1238
|
+
*
|
|
1239
|
+
* Deprecated: use /v2/organization/feature-settings instead.
|
|
1240
|
+
*/
|
|
1241
|
+
'get'(
|
|
1242
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1243
|
+
data?: any,
|
|
1244
|
+
config?: AxiosRequestConfig
|
|
1218
1245
|
): OperationResponse<Paths.GetFeatureSettings.Responses.$200>
|
|
1219
1246
|
}
|
|
1220
1247
|
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/partner-directory.json
|
|
4
|
+
var partner_directory_default = '# Partner API\n\n- **Base URL:** `https://partner-directory-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/partner-directory](https://docs.epilot.io/api/partner-directory)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.partnerDirectory.approvePartner(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/partner-directory\'\n\nconst partnerDirectoryClient = getClient()\nauthorize(partnerDirectoryClient, () => \'<token>\')\nconst { data } = await partnerDirectoryClient.approvePartner(...)\n```\n\n## Operations\n\n**partners**\n- [`approvePartner`](#approvepartner)\n- [`rejectPartner`](#rejectpartner)\n- [`searchAssignable`](#searchassignable)\n- [`batchGetAssignable`](#batchgetassignable)\n- [`getPartnerByToken`](#getpartnerbytoken)\n- [`activatePartner`](#activatepartner)\n- [`searchGeolocationForText`](#searchgeolocationfortext)\n- [`invitePartnerV2`](#invitepartnerv2)\n\n**partner_users**\n- [`getPartnerUsers`](#getpartnerusers)\n- [`createPartnerUser`](#createpartneruser)\n- [`deletePartnerUser`](#deletepartneruser)\n- [`getPartnerRoles`](#getpartnerroles)\n- [`createPartnerRole`](#createpartnerrole)\n- [`updatePartnerRole`](#updatepartnerrole)\n- [`assignPartnerUserRoles`](#assignpartneruserroles)\n- [`unassignPartnerUserRoles`](#unassignpartneruserroles)\n\n**Schemas**\n- [`InviteToken`](#invitetoken)\n- [`Partner`](#partner)\n- [`PartnerId`](#partnerid)\n- [`OrganizationId`](#organizationid)\n- [`ActivatePartnerPayload`](#activatepartnerpayload)\n- [`PartnerInvitationPayload`](#partnerinvitationpayload)\n- [`Assignable`](#assignable)\n- [`BaseAssignable`](#baseassignable)\n- [`AssignableUser`](#assignableuser)\n- [`AssignablePartnerUser`](#assignablepartneruser)\n- [`AssignableGroup`](#assignablegroup)\n- [`AssignableOrganization`](#assignableorganization)\n- [`AssignableEcpPlaceholder`](#assignableecpplaceholder)\n- [`SearchGeolocation`](#searchgeolocation)\n- [`Geolocation`](#geolocation)\n- [`Address`](#address)\n- [`AddressGeolocation`](#addressgeolocation)\n- [`PartnerUser`](#partneruser)\n- [`CreatePartnerUserPayload`](#createpartneruserpayload)\n- [`CreatePartnerRolePayload`](#createpartnerrolepayload)\n- [`UpdatePartnerRolePayload`](#updatepartnerrolepayload)\n- [`Grant`](#grant)\n- [`GrantWithDependencies`](#grantwithdependencies)\n- [`GrantCondition`](#grantcondition)\n- [`EqualsCondition`](#equalscondition)\n- [`RoleId`](#roleid)\n- [`BaseRoleForCreate`](#baseroleforcreate)\n- [`PartnerRole`](#partnerrole)\n- [`AssignRolesPayload`](#assignrolespayload)\n- [`User`](#user)\n\n### `approvePartner`\n\nApprove partner request\n\n`POST /v1/partners/{id}/approve`\n\n```ts\nconst { data } = await client.approvePartner({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `rejectPartner`\n\nReject partner request\n\n`POST /v1/partners/{id}/reject`\n\n```ts\nconst { data } = await client.rejectPartner({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `searchAssignable`\n\nsearchAssignables\n\n`POST /v1/partners/assignables:search`\n\n```ts\nconst { data } = await client.searchAssignable(\n null,\n {\n q: \'\',\n from: 0,\n size: 25,\n org_ids: [\'123\'],\n portalUsersEntityIdScope: \'\',\n types: [\'user\', \'partner_user\', \'partner_organization\', \'ecp\', \'group\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 25,\n "results": [\n {\n "type": "user",\n "display_name": "Example User",\n "image_uri": {\n "original": "https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png",\n "thumbnail_32": "https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png"\n },\n "org_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "activated_at": "2022-02-08T04:44:32.246Z",\n "status": "Active",\n "user_id": "456",\n "email": "example@example.com"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `batchGetAssignable`\n\nbatchGet\n\n`POST /v1/partners/assignables:batchGet`\n\n```ts\nconst { data } = await client.batchGetAssignable(\n null,\n [\n {\n user_id: \'string\',\n org_id: \'string\',\n group_id: \'string\'\n }\n ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 25,\n "results": [\n {\n "type": "user",\n "display_name": "Example User",\n "image_uri": {\n "original": "https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png",\n "thumbnail_32": "https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png"\n },\n "org_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "activated_at": "2022-02-08T04:44:32.246Z",\n "status": "Active",\n "user_id": "456",\n "email": "example@example.com"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPartnerByToken`\n\nGet partner by token\n\n`GET /v1/partner-directory/public/getPartnerByToken`\n\n```ts\nconst { data } = await client.getPartnerByToken({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `activatePartner`\n\nActivate partner using an invite token\n\n`POST /v1/partner-directory/public/activate`\n\n```ts\nconst { data } = await client.activatePartner(\n {\n token: \'example\',\n },\n {\n company_name: \'Company name\',\n signed_up_email: \'user@example.com\',\n organization_id: \'string\'\n },\n)\n```\n\n---\n\n### `searchGeolocationForText`\n\nConverts a given string, in the format of an address, to geo-location latitude and longitude\n\n`POST /v1/geolocation/text:search`\n\n```ts\nconst { data } = await client.searchGeolocationForText(\n null,\n {\n address: \'Auweg 1, 93055 Regensburg, DE\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "lat": 49.013,\n "lng": 12.101,\n "addressLabel": "string",\n "relevance": 0\n}\n```\n\n</details>\n\n---\n\n### `invitePartnerV2`\n\nInvite a partner into collaboration. It will send an email to partner and ask to join into collaboration\n\n`POST /v2/partners/{id}/invite`\n\n```ts\nconst { data } = await client.invitePartnerV2(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `getPartnerUsers`\n\nGet all users for a partner organization with their roles\n\n`GET /v2/partners/{orgId}/users`\n\n```ts\nconst { data } = await client.getPartnerUsers({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "456",\n "name": "John Doe",\n "email": "user@example.com",\n "status": "Active",\n "image": {\n "original": "https://example.com/path",\n "thumbnail_32": "https://example.com/path"\n },\n "roles": [\n {\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createPartnerUser`\n\nCreate a new user in a partner organization\n\n`POST /v2/partners/{orgId}/users`\n\n```ts\nconst { data } = await client.createPartnerUser(\n {\n orgId: \'example\',\n },\n {\n email: \'user@example.com\',\n language: \'en\',\n roles: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "456",\n "email": "user@example.com",\n "display_name": "John Doe",\n "status": "Active"\n}\n```\n\n</details>\n\n---\n\n### `deletePartnerUser`\n\nDelete a user from a partner organization\n\n`DELETE /v2/partners/{orgId}/users/{userId}`\n\n```ts\nconst { data } = await client.deletePartnerUser({\n orgId: \'example\',\n userId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getPartnerRoles`\n\nGet all roles for a partner organization\n\n`GET /v2/partners/{orgId}/roles`\n\n```ts\nconst { data } = await client.getPartnerRoles({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createPartnerRole`\n\nCreate a role for a partner organization\n\n`POST /v2/partners/{orgId}/roles`\n\n```ts\nconst { data } = await client.createPartnerRole(\n {\n orgId: \'example\',\n },\n {\n name: \'Partner Admin\',\n slug: \'partner_admin\',\n grants: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ],\n dependencies: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ]\n }\n ]\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n}\n```\n\n</details>\n\n---\n\n### `updatePartnerRole`\n\nUpdate a role for a partner organization\n\n`PUT /v2/partners/{orgId}/roles/{roleId}`\n\n```ts\nconst { data } = await client.updatePartnerRole(\n {\n orgId: \'example\',\n roleId: \'example\',\n },\n {\n grants: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ],\n dependencies: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ]\n }\n ]\n }\n ],\n id: \'123:owner\',\n name: \'Owner\',\n slug: \'owner\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n}\n```\n\n</details>\n\n---\n\n### `assignPartnerUserRoles`\n\nAssign roles to a user in a partner organization\n\n`POST /v2/partners/{orgId}/users/{userId}/roles`\n\n```ts\nconst { data } = await client.assignPartnerUserRoles(\n {\n orgId: \'example\',\n userId: \'example\',\n },\n {\n roleIds: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "roleId": "string",\n "success": true,\n "data": {},\n "error": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `unassignPartnerUserRoles`\n\nUnassign roles from a user in a partner organization\n\n`DELETE /v2/partners/{orgId}/users/{userId}/roles`\n\n```ts\nconst { data } = await client.unassignPartnerUserRoles(\n {\n orgId: \'example\',\n userId: \'example\',\n },\n {\n roleIds: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "roleId": "string",\n "success": true,\n "data": {},\n "error": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `InviteToken`\n\n```ts\ntype InviteToken = string\n```\n\n### `Partner`\n\n```ts\ntype Partner = {\n id?: string\n organization_id?: string\n created_at?: string\n description?: string\n company_name?: string\n invitation_token?: string\n invitation_email?: string // email\n email?: string // email\n owner_email?: string // email\n signed_up_email?: string // email\n partner_org_id?: string\n status?: "Pending" | "Request" | "Deleted" | "Invited" | "Rejected"\n}\n```\n\n### `PartnerId`\n\n```ts\ntype PartnerId = string\n```\n\n### `OrganizationId`\n\n```ts\ntype OrganizationId = string\n```\n\n### `ActivatePartnerPayload`\n\n```ts\ntype ActivatePartnerPayload = {\n company_name?: string\n signed_up_email: string // email\n organization_id: string\n}\n```\n\n### `PartnerInvitationPayload`\n\n```ts\ntype PartnerInvitationPayload = {\n language?: "en" | "de"\n}\n```\n\n### `Assignable`\n\n```ts\ntype Assignable = {\n type: "user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id?: string\n email?: string\n} | {\n type: "partner_user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id?: string\n user_id?: string\n email?: string\n} | {\n type: "partner_organization"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id: string\n email?: string\n geolocations?: Array<{\n address?: {\n street?: { ... }\n street_number?: { ... }\n city?: { ... }\n postal_code?: { ... }\n country?: { ... }\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n }>\n phone?: string\n activity_radius?: number\n} | {\n type: "ecp"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id: string\n email?: string\n} | {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n group_id?: string\n}\n```\n\n### `BaseAssignable`\n\n```ts\ntype BaseAssignable = {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n}\n```\n\n### `AssignableUser`\n\n```ts\ntype AssignableUser = {\n type: "user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id?: string\n email?: string\n}\n```\n\n### `AssignablePartnerUser`\n\n```ts\ntype AssignablePartnerUser = {\n type: "partner_user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id?: string\n user_id?: string\n email?: string\n}\n```\n\n### `AssignableGroup`\n\n```ts\ntype AssignableGroup = {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n group_id?: string\n}\n```\n\n### `AssignableOrganization`\n\n```ts\ntype AssignableOrganization = {\n type: "partner_organization"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id: string\n email?: string\n geolocations?: Array<{\n address?: {\n street?: { ... }\n street_number?: { ... }\n city?: { ... }\n postal_code?: { ... }\n country?: { ... }\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n }>\n phone?: string\n activity_radius?: number\n}\n```\n\n### `AssignableEcpPlaceholder`\n\n```ts\ntype AssignableEcpPlaceholder = {\n type: "ecp"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id: string\n email?: string\n}\n```\n\n### `SearchGeolocation`\n\n```ts\ntype SearchGeolocation = {\n address: string\n}\n```\n\n### `Geolocation`\n\n```ts\ntype Geolocation = {\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n}\n```\n\n### `Address`\n\n```ts\ntype Address = {\n street?: string\n street_number?: string\n city?: string\n postal_code?: string\n country?: string\n}\n```\n\n### `AddressGeolocation`\n\n```ts\ntype AddressGeolocation = {\n address?: {\n street?: string\n street_number?: string\n city?: string\n postal_code?: string\n country?: string\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n}\n```\n\n### `PartnerUser`\n\n```ts\ntype PartnerUser = {\n id: string\n name?: string\n email: string // email\n status: string\n image?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n roles: Array<{\n id: string\n slug: string\n name: string\n }>\n}\n```\n\n### `CreatePartnerUserPayload`\n\n```ts\ntype CreatePartnerUserPayload = {\n email: string // email\n language?: "en" | "de"\n roles?: string[]\n}\n```\n\n### `CreatePartnerRolePayload`\n\n```ts\ntype CreatePartnerRolePayload = {\n name: string\n slug: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n dependencies?: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n }>\n}\n```\n\n### `UpdatePartnerRolePayload`\n\n```ts\ntype UpdatePartnerRolePayload = {\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n id?: string\n name: string\n slug: string\n}\n```\n\n### `Grant`\n\n```ts\ntype Grant = {\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n}\n```\n\n### `GrantWithDependencies`\n\n```ts\ntype GrantWithDependencies = {\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n dependencies?: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `GrantCondition`\n\n```ts\ntype GrantCondition = object\n```\n\n### `EqualsCondition`\n\nCheck if attribute equals to any of the values\n\n```ts\ntype EqualsCondition = {\n attribute: string\n operation: "equals"\n values: unknown[]\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `BaseRoleForCreate`\n\n```ts\ntype BaseRoleForCreate = {\n id?: string\n name: string\n slug: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `PartnerRole`\n\n```ts\ntype PartnerRole = {\n id: string\n slug: string\n name: string\n type?: string\n}\n```\n\n### `AssignRolesPayload`\n\n```ts\ntype AssignRolesPayload = {\n roleIds: string[]\n}\n```\n\n### `User`\n\n```ts\ntype User = {\n id?: string\n email?: string // email\n display_name?: string\n status?: string\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
partner_directory_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/partner-directory.json
|
|
4
|
+
var partner_directory_default = '# Partner API\n\n- **Base URL:** `https://partner-directory-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/partner-directory](https://docs.epilot.io/api/partner-directory)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.partnerDirectory.approvePartner(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/partner-directory\'\n\nconst partnerDirectoryClient = getClient()\nauthorize(partnerDirectoryClient, () => \'<token>\')\nconst { data } = await partnerDirectoryClient.approvePartner(...)\n```\n\n## Operations\n\n**partners**\n- [`approvePartner`](#approvepartner)\n- [`rejectPartner`](#rejectpartner)\n- [`searchAssignable`](#searchassignable)\n- [`batchGetAssignable`](#batchgetassignable)\n- [`getPartnerByToken`](#getpartnerbytoken)\n- [`activatePartner`](#activatepartner)\n- [`searchGeolocationForText`](#searchgeolocationfortext)\n- [`invitePartnerV2`](#invitepartnerv2)\n\n**partner_users**\n- [`getPartnerUsers`](#getpartnerusers)\n- [`createPartnerUser`](#createpartneruser)\n- [`deletePartnerUser`](#deletepartneruser)\n- [`getPartnerRoles`](#getpartnerroles)\n- [`createPartnerRole`](#createpartnerrole)\n- [`updatePartnerRole`](#updatepartnerrole)\n- [`assignPartnerUserRoles`](#assignpartneruserroles)\n- [`unassignPartnerUserRoles`](#unassignpartneruserroles)\n\n**Schemas**\n- [`InviteToken`](#invitetoken)\n- [`Partner`](#partner)\n- [`PartnerId`](#partnerid)\n- [`OrganizationId`](#organizationid)\n- [`ActivatePartnerPayload`](#activatepartnerpayload)\n- [`PartnerInvitationPayload`](#partnerinvitationpayload)\n- [`Assignable`](#assignable)\n- [`BaseAssignable`](#baseassignable)\n- [`AssignableUser`](#assignableuser)\n- [`AssignablePartnerUser`](#assignablepartneruser)\n- [`AssignableGroup`](#assignablegroup)\n- [`AssignableOrganization`](#assignableorganization)\n- [`AssignableEcpPlaceholder`](#assignableecpplaceholder)\n- [`SearchGeolocation`](#searchgeolocation)\n- [`Geolocation`](#geolocation)\n- [`Address`](#address)\n- [`AddressGeolocation`](#addressgeolocation)\n- [`PartnerUser`](#partneruser)\n- [`CreatePartnerUserPayload`](#createpartneruserpayload)\n- [`CreatePartnerRolePayload`](#createpartnerrolepayload)\n- [`UpdatePartnerRolePayload`](#updatepartnerrolepayload)\n- [`Grant`](#grant)\n- [`GrantWithDependencies`](#grantwithdependencies)\n- [`GrantCondition`](#grantcondition)\n- [`EqualsCondition`](#equalscondition)\n- [`RoleId`](#roleid)\n- [`BaseRoleForCreate`](#baseroleforcreate)\n- [`PartnerRole`](#partnerrole)\n- [`AssignRolesPayload`](#assignrolespayload)\n- [`User`](#user)\n\n### `approvePartner`\n\nApprove partner request\n\n`POST /v1/partners/{id}/approve`\n\n```ts\nconst { data } = await client.approvePartner({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `rejectPartner`\n\nReject partner request\n\n`POST /v1/partners/{id}/reject`\n\n```ts\nconst { data } = await client.rejectPartner({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `searchAssignable`\n\nsearchAssignables\n\n`POST /v1/partners/assignables:search`\n\n```ts\nconst { data } = await client.searchAssignable(\n null,\n {\n q: \'\',\n from: 0,\n size: 25,\n org_ids: [\'123\'],\n portalUsersEntityIdScope: \'\',\n types: [\'user\', \'partner_user\', \'partner_organization\', \'ecp\', \'group\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 25,\n "results": [\n {\n "type": "user",\n "display_name": "Example User",\n "image_uri": {\n "original": "https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png",\n "thumbnail_32": "https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png"\n },\n "org_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "activated_at": "2022-02-08T04:44:32.246Z",\n "status": "Active",\n "user_id": "456",\n "email": "example@example.com"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `batchGetAssignable`\n\nbatchGet\n\n`POST /v1/partners/assignables:batchGet`\n\n```ts\nconst { data } = await client.batchGetAssignable(\n null,\n [\n {\n user_id: \'string\',\n org_id: \'string\',\n group_id: \'string\'\n }\n ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 25,\n "results": [\n {\n "type": "user",\n "display_name": "Example User",\n "image_uri": {\n "original": "https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png",\n "thumbnail_32": "https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png"\n },\n "org_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "activated_at": "2022-02-08T04:44:32.246Z",\n "status": "Active",\n "user_id": "456",\n "email": "example@example.com"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPartnerByToken`\n\nGet partner by token\n\n`GET /v1/partner-directory/public/getPartnerByToken`\n\n```ts\nconst { data } = await client.getPartnerByToken({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `activatePartner`\n\nActivate partner using an invite token\n\n`POST /v1/partner-directory/public/activate`\n\n```ts\nconst { data } = await client.activatePartner(\n {\n token: \'example\',\n },\n {\n company_name: \'Company name\',\n signed_up_email: \'user@example.com\',\n organization_id: \'string\'\n },\n)\n```\n\n---\n\n### `searchGeolocationForText`\n\nConverts a given string, in the format of an address, to geo-location latitude and longitude\n\n`POST /v1/geolocation/text:search`\n\n```ts\nconst { data } = await client.searchGeolocationForText(\n null,\n {\n address: \'Auweg 1, 93055 Regensburg, DE\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "lat": 49.013,\n "lng": 12.101,\n "addressLabel": "string",\n "relevance": 0\n}\n```\n\n</details>\n\n---\n\n### `invitePartnerV2`\n\nInvite a partner into collaboration. It will send an email to partner and ask to join into collaboration\n\n`POST /v2/partners/{id}/invite`\n\n```ts\nconst { data } = await client.invitePartnerV2(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `getPartnerUsers`\n\nGet all users for a partner organization with their roles\n\n`GET /v2/partners/{orgId}/users`\n\n```ts\nconst { data } = await client.getPartnerUsers({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "456",\n "name": "John Doe",\n "email": "user@example.com",\n "status": "Active",\n "image": {\n "original": "https://example.com/path",\n "thumbnail_32": "https://example.com/path"\n },\n "roles": [\n {\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createPartnerUser`\n\nCreate a new user in a partner organization\n\n`POST /v2/partners/{orgId}/users`\n\n```ts\nconst { data } = await client.createPartnerUser(\n {\n orgId: \'example\',\n },\n {\n email: \'user@example.com\',\n language: \'en\',\n roles: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "456",\n "email": "user@example.com",\n "display_name": "John Doe",\n "status": "Active"\n}\n```\n\n</details>\n\n---\n\n### `deletePartnerUser`\n\nDelete a user from a partner organization\n\n`DELETE /v2/partners/{orgId}/users/{userId}`\n\n```ts\nconst { data } = await client.deletePartnerUser({\n orgId: \'example\',\n userId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getPartnerRoles`\n\nGet all roles for a partner organization\n\n`GET /v2/partners/{orgId}/roles`\n\n```ts\nconst { data } = await client.getPartnerRoles({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createPartnerRole`\n\nCreate a role for a partner organization\n\n`POST /v2/partners/{orgId}/roles`\n\n```ts\nconst { data } = await client.createPartnerRole(\n {\n orgId: \'example\',\n },\n {\n name: \'Partner Admin\',\n slug: \'partner_admin\',\n grants: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ],\n dependencies: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ]\n }\n ]\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n}\n```\n\n</details>\n\n---\n\n### `updatePartnerRole`\n\nUpdate a role for a partner organization\n\n`PUT /v2/partners/{orgId}/roles/{roleId}`\n\n```ts\nconst { data } = await client.updatePartnerRole(\n {\n orgId: \'example\',\n roleId: \'example\',\n },\n {\n grants: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ],\n dependencies: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ]\n }\n ]\n }\n ],\n id: \'123:owner\',\n name: \'Owner\',\n slug: \'owner\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n}\n```\n\n</details>\n\n---\n\n### `assignPartnerUserRoles`\n\nAssign roles to a user in a partner organization\n\n`POST /v2/partners/{orgId}/users/{userId}/roles`\n\n```ts\nconst { data } = await client.assignPartnerUserRoles(\n {\n orgId: \'example\',\n userId: \'example\',\n },\n {\n roleIds: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "roleId": "string",\n "success": true,\n "data": {},\n "error": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `unassignPartnerUserRoles`\n\nUnassign roles from a user in a partner organization\n\n`DELETE /v2/partners/{orgId}/users/{userId}/roles`\n\n```ts\nconst { data } = await client.unassignPartnerUserRoles(\n {\n orgId: \'example\',\n userId: \'example\',\n },\n {\n roleIds: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "roleId": "string",\n "success": true,\n "data": {},\n "error": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `InviteToken`\n\n```ts\ntype InviteToken = string\n```\n\n### `Partner`\n\n```ts\ntype Partner = {\n id?: string\n organization_id?: string\n created_at?: string\n description?: string\n company_name?: string\n invitation_token?: string\n invitation_email?: string // email\n email?: string // email\n owner_email?: string // email\n signed_up_email?: string // email\n partner_org_id?: string\n status?: "Pending" | "Request" | "Deleted" | "Invited" | "Rejected"\n}\n```\n\n### `PartnerId`\n\n```ts\ntype PartnerId = string\n```\n\n### `OrganizationId`\n\n```ts\ntype OrganizationId = string\n```\n\n### `ActivatePartnerPayload`\n\n```ts\ntype ActivatePartnerPayload = {\n company_name?: string\n signed_up_email: string // email\n organization_id: string\n}\n```\n\n### `PartnerInvitationPayload`\n\n```ts\ntype PartnerInvitationPayload = {\n language?: "en" | "de"\n}\n```\n\n### `Assignable`\n\n```ts\ntype Assignable = {\n type: "user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id?: string\n email?: string\n} | {\n type: "partner_user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id?: string\n user_id?: string\n email?: string\n} | {\n type: "partner_organization"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id: string\n email?: string\n geolocations?: Array<{\n address?: {\n street?: { ... }\n street_number?: { ... }\n city?: { ... }\n postal_code?: { ... }\n country?: { ... }\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n }>\n phone?: string\n activity_radius?: number\n} | {\n type: "ecp"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id: string\n email?: string\n} | {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n group_id?: string\n}\n```\n\n### `BaseAssignable`\n\n```ts\ntype BaseAssignable = {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n}\n```\n\n### `AssignableUser`\n\n```ts\ntype AssignableUser = {\n type: "user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id?: string\n email?: string\n}\n```\n\n### `AssignablePartnerUser`\n\n```ts\ntype AssignablePartnerUser = {\n type: "partner_user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id?: string\n user_id?: string\n email?: string\n}\n```\n\n### `AssignableGroup`\n\n```ts\ntype AssignableGroup = {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n group_id?: string\n}\n```\n\n### `AssignableOrganization`\n\n```ts\ntype AssignableOrganization = {\n type: "partner_organization"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id: string\n email?: string\n geolocations?: Array<{\n address?: {\n street?: { ... }\n street_number?: { ... }\n city?: { ... }\n postal_code?: { ... }\n country?: { ... }\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n }>\n phone?: string\n activity_radius?: number\n}\n```\n\n### `AssignableEcpPlaceholder`\n\n```ts\ntype AssignableEcpPlaceholder = {\n type: "ecp"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id: string\n email?: string\n}\n```\n\n### `SearchGeolocation`\n\n```ts\ntype SearchGeolocation = {\n address: string\n}\n```\n\n### `Geolocation`\n\n```ts\ntype Geolocation = {\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n}\n```\n\n### `Address`\n\n```ts\ntype Address = {\n street?: string\n street_number?: string\n city?: string\n postal_code?: string\n country?: string\n}\n```\n\n### `AddressGeolocation`\n\n```ts\ntype AddressGeolocation = {\n address?: {\n street?: string\n street_number?: string\n city?: string\n postal_code?: string\n country?: string\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n}\n```\n\n### `PartnerUser`\n\n```ts\ntype PartnerUser = {\n id: string\n name?: string\n email: string // email\n status: string\n image?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n roles: Array<{\n id: string\n slug: string\n name: string\n }>\n}\n```\n\n### `CreatePartnerUserPayload`\n\n```ts\ntype CreatePartnerUserPayload = {\n email: string // email\n language?: "en" | "de"\n roles?: string[]\n}\n```\n\n### `CreatePartnerRolePayload`\n\n```ts\ntype CreatePartnerRolePayload = {\n name: string\n slug: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n dependencies?: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n }>\n}\n```\n\n### `UpdatePartnerRolePayload`\n\n```ts\ntype UpdatePartnerRolePayload = {\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n id?: string\n name: string\n slug: string\n}\n```\n\n### `Grant`\n\n```ts\ntype Grant = {\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n}\n```\n\n### `GrantWithDependencies`\n\n```ts\ntype GrantWithDependencies = {\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n dependencies?: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `GrantCondition`\n\n```ts\ntype GrantCondition = object\n```\n\n### `EqualsCondition`\n\nCheck if attribute equals to any of the values\n\n```ts\ntype EqualsCondition = {\n attribute: string\n operation: "equals"\n values: unknown[]\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `BaseRoleForCreate`\n\n```ts\ntype BaseRoleForCreate = {\n id?: string\n name: string\n slug: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `PartnerRole`\n\n```ts\ntype PartnerRole = {\n id: string\n slug: string\n name: string\n type?: string\n}\n```\n\n### `AssignRolesPayload`\n\n```ts\ntype AssignRolesPayload = {\n roleIds: string[]\n}\n```\n\n### `User`\n\n```ts\ntype User = {\n id?: string\n email?: string // email\n display_name?: string\n status?: string\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = partner_directory_default;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/permissions.json
|
|
4
|
+
var permissions_default = '# Permissions API\n\n- **Base URL:** `https://permissions.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/permissions](https://docs.epilot.io/api/permissions)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.permissions.listCurrentRoles(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/permissions\'\n\nconst permissionsClient = getClient()\nauthorize(permissionsClient, () => \'<token>\')\nconst { data } = await permissionsClient.listCurrentRoles(...)\n```\n\n## Operations\n\n**Roles**\n- [`listCurrentRoles`](#listcurrentroles)\n- [`listAllRoles`](#listallroles)\n- [`createRole`](#createrole)\n- [`searchRoles`](#searchroles)\n- [`getRole`](#getrole)\n- [`putRole`](#putrole)\n- [`deleteRole`](#deleterole)\n- [`refreshPermissions`](#refreshpermissions)\n\n**Assignments**\n- [`getAssignedRolesForUser`](#getassignedrolesforuser)\n- [`assignRoles`](#assignroles)\n- [`addAssignment`](#addassignment)\n- [`removeAssignment`](#removeassignment)\n- [`listAllAssignments`](#listallassignments)\n\n**Schemas**\n- [`Grant`](#grant)\n- [`GrantWithDependencies`](#grantwithdependencies)\n- [`GrantCondition`](#grantcondition)\n- [`EqualsCondition`](#equalscondition)\n- [`RoleId`](#roleid)\n- [`BaseRole`](#baserole)\n- [`BaseRoleForCreate`](#baseroleforcreate)\n- [`UserRole`](#userrole)\n- [`OrgRole`](#orgrole)\n- [`ShareRole`](#sharerole)\n- [`PartnerRole`](#partnerrole)\n- [`PortalRole`](#portalrole)\n- [`Role`](#role)\n- [`RolePayload`](#rolepayload)\n- [`Assignment`](#assignment)\n- [`InternalAssignment`](#internalassignment)\n- [`OrgAssignments`](#orgassignments)\n- [`OrgRoles`](#orgroles)\n- [`Assignments`](#assignments)\n- [`UserId`](#userid)\n- [`OrganizationId`](#organizationid)\n- [`Slug`](#slug)\n- [`RoleSearchInput`](#rolesearchinput)\n- [`CreateRolePayload`](#createrolepayload)\n- [`Error`](#error)\n\n### `listCurrentRoles`\n\nReturns roles and grants assigned to current user\n\n`GET /v1/permissions/me`\n\n```ts\nconst { data } = await client.listCurrentRoles()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "roles": [\n {\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listAllRoles`\n\nReturns list of all roles in organization\n\n`GET /v1/permissions/roles`\n\n```ts\nconst { data } = await client.listAllRoles()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "roles": [\n {\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createRole`\n\nCreate role\n\n`POST /v1/permissions/roles`\n\n```ts\nconst { data } = await client.createRole(\n null,\n {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n}\n```\n\n</details>\n\n---\n\n### `searchRoles`\n\nSearch Roles\n\n`POST /v1/permissions/roles:search`\n\n```ts\nconst { data } = await client.searchRoles(\n null,\n {\n role_ids: [\'123:manager\', \'456:owner\'],\n org_ids: [\'123\', \'456\'],\n slugs: [\'manager\', \'owner\'],\n query: \'Administrator\',\n limit: 1,\n offset: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getRole`\n\nGet role by id\n\n`GET /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.getRole({\n roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n}\n```\n\n</details>\n\n---\n\n### `putRole`\n\nCreate or update role\n\n`PUT /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.putRole(\n {\n roleId: \'example\',\n },\n {\n id: \'123:owner\',\n name: \'Owner\',\n slug: \'owner\',\n type: \'user_role\',\n expires_at: \'2028-07-21T17:32:28Z\',\n organization_id: \'123\',\n grants: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ]\n }\n ],\n parent_role: \'123:owner\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n}\n```\n\n</details>\n\n---\n\n### `deleteRole`\n\nDelete role by id\n\n`DELETE /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.deleteRole({\n roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n}\n```\n\n</details>\n\n---\n\n### `refreshPermissions`\n\nMakes sure the user has a role in the organization\n\n`GET /v1/permissions/refresh`\n\n```ts\nconst { data } = await client.refreshPermissions()\n```\n\n---\n\n### `getAssignedRolesForUser`\n\nGet list of assigned roles by user id\n\n`GET /v1/permissions/assignments/{userId}`\n\n```ts\nconst { data } = await client.getAssignedRolesForUser({\n userId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["123:owner"]\n```\n\n</details>\n\n---\n\n### `assignRoles`\n\nAssign / unassign roles to users.\n\n`PUT /v1/permissions/assignments/{userId}`\n\n```ts\nconst { data } = await client.assignRoles(\n {\n userId: \'example\',\n },\n [\'123:owner\'],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["123:owner"]\n```\n\n</details>\n\n---\n\n### `addAssignment`\n\nAssign a user to a role.\n\n`POST /v1/permissions/assignments/{userId}/{roleId}`\n\n```ts\nconst { data } = await client.addAssignment({\n userId: \'example\',\n roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "user_id": "1",\n "roles": ["123:owner"]\n}\n```\n\n</details>\n\n---\n\n### `removeAssignment`\n\nRemove role assignment from user\n\n`DELETE /v1/permissions/assignments/{userId}/{roleId}`\n\n```ts\nconst { data } = await client.removeAssignment({\n userId: \'example\',\n roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "user_id": "1",\n "roles": ["123:owner"]\n}\n```\n\n</details>\n\n---\n\n### `listAllAssignments`\n\nReturns list of all assignments in organization\n\n`GET /v1/permissions/assignments`\n\n```ts\nconst { data } = await client.listAllAssignments()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "assignments": [\n {\n "user_id": "1",\n "roles": ["123:owner"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Grant`\n\n```ts\ntype Grant = {\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n}\n```\n\n### `GrantWithDependencies`\n\n```ts\ntype GrantWithDependencies = {\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n dependencies?: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `GrantCondition`\n\n```ts\ntype GrantCondition = object\n```\n\n### `EqualsCondition`\n\nCheck if attribute equals to any of the values\n\n```ts\ntype EqualsCondition = {\n attribute: string\n operation: "equals"\n values: unknown[]\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `BaseRole`\n\n```ts\ntype BaseRole = {\n id: string\n name: string\n slug: string\n type: string\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `BaseRoleForCreate`\n\n```ts\ntype BaseRoleForCreate = {\n id?: string\n name: string\n slug: string\n type: string\n expires_at?: string // date-time\n organization_id?: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `UserRole`\n\n```ts\ntype UserRole = {\n id: string\n name: string\n slug: string\n type: "user_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n parent_role?: object\n}\n```\n\n### `OrgRole`\n\n```ts\ntype OrgRole = {\n id: string\n name: string\n slug: string\n type: "org_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n pricing_tier?: string\n}\n```\n\n### `ShareRole`\n\n```ts\ntype ShareRole = {\n id: string\n name: string\n slug: string\n type: "share_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `PartnerRole`\n\n```ts\ntype PartnerRole = {\n id: string\n name: string\n slug: string\n type: "partner_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n partner_org_id?: object\n vendor_enforced_user_limit?: number\n}\n```\n\n### `PortalRole`\n\n```ts\ntype PortalRole = {\n id: string\n name: string\n slug: string\n type: "portal_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `Role`\n\n```ts\ntype Role = {\n id: string\n name: string\n slug: string\n type: "user_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n parent_role?: object\n} | {\n id: string\n name: string\n slug: string\n type: "org_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n pricing_tier?: string\n} | {\n id: string\n name: string\n slug: string\n type: "share_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n} | {\n id: string\n name: string\n slug: string\n type: "partner_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n partner_org_id?: object\n vendor_enforced_user_limit?: number\n} | {\n id: string\n name: string\n slug: string\n type: "portal_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `RolePayload`\n\n```ts\ntype RolePayload = {\n grants?: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n dependencies?: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n }>\n}\n```\n\n### `Assignment`\n\nA role attached to an user\n\n```ts\ntype Assignment = {\n user_id?: string\n roles?: string[]\n}\n```\n\n### `InternalAssignment`\n\nA role attached to an user\n\n```ts\ntype InternalAssignment = {\n userId?: string\n roles?: string[]\n}\n```\n\n### `OrgAssignments`\n\nAll roles attached to an users of an organization\n\n```ts\ntype OrgAssignments = {\n organizationId?: string\n assignments?: Array<{\n userId?: string\n roles?: string[]\n }>\n}\n```\n\n### `OrgRoles`\n\nAll roles attached to an users of an organization\n\n```ts\ntype OrgRoles = {\n organizationId?: string\n roles?: Array<{\n id: string\n name: string\n slug: string\n type: "user_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n parent_role?: object\n } | {\n id: string\n name: string\n slug: string\n type: "org_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n pricing_tier?: string\n } | {\n id: string\n name: string\n slug: string\n type: "share_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n } | {\n id: string\n name: string\n slug: string\n type: "partner_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n partner_org_id?: object\n vendor_enforced_user_limit?: number\n } | {\n id: string\n name: string\n slug: string\n type: "portal_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n }>\n}\n```\n\n### `Assignments`\n\nList of role ids attached to an user\n\n```ts\ntype Assignments = string[]\n```\n\n### `UserId`\n\nId of a user\n\n```ts\ntype UserId = string\n```\n\n### `OrganizationId`\n\nId of an organization\n\n```ts\ntype OrganizationId = string\n```\n\n### `Slug`\n\nSlug of a role; for a role with id = 123:manager -> 123 is org_id & manager is slug\n\n```ts\ntype Slug = string\n```\n\n### `RoleSearchInput`\n\n```ts\ntype RoleSearchInput = {\n role_ids?: string[]\n org_ids?: string[]\n slugs?: string[]\n query?: string\n limit?: number\n offset?: number\n}\n```\n\n### `CreateRolePayload`\n\n```ts\ntype CreateRolePayload = {\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n id?: string\n name: string\n slug: string\n type: string\n expires_at?: string // date-time\n organization_id?: string\n}\n```\n\n### `Error`\n\nError response\n\n```ts\ntype Error = {\n message: string\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
permissions_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/permissions.json
|
|
4
|
+
var permissions_default = '# Permissions API\n\n- **Base URL:** `https://permissions.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/permissions](https://docs.epilot.io/api/permissions)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.permissions.listCurrentRoles(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/permissions\'\n\nconst permissionsClient = getClient()\nauthorize(permissionsClient, () => \'<token>\')\nconst { data } = await permissionsClient.listCurrentRoles(...)\n```\n\n## Operations\n\n**Roles**\n- [`listCurrentRoles`](#listcurrentroles)\n- [`listAllRoles`](#listallroles)\n- [`createRole`](#createrole)\n- [`searchRoles`](#searchroles)\n- [`getRole`](#getrole)\n- [`putRole`](#putrole)\n- [`deleteRole`](#deleterole)\n- [`refreshPermissions`](#refreshpermissions)\n\n**Assignments**\n- [`getAssignedRolesForUser`](#getassignedrolesforuser)\n- [`assignRoles`](#assignroles)\n- [`addAssignment`](#addassignment)\n- [`removeAssignment`](#removeassignment)\n- [`listAllAssignments`](#listallassignments)\n\n**Schemas**\n- [`Grant`](#grant)\n- [`GrantWithDependencies`](#grantwithdependencies)\n- [`GrantCondition`](#grantcondition)\n- [`EqualsCondition`](#equalscondition)\n- [`RoleId`](#roleid)\n- [`BaseRole`](#baserole)\n- [`BaseRoleForCreate`](#baseroleforcreate)\n- [`UserRole`](#userrole)\n- [`OrgRole`](#orgrole)\n- [`ShareRole`](#sharerole)\n- [`PartnerRole`](#partnerrole)\n- [`PortalRole`](#portalrole)\n- [`Role`](#role)\n- [`RolePayload`](#rolepayload)\n- [`Assignment`](#assignment)\n- [`InternalAssignment`](#internalassignment)\n- [`OrgAssignments`](#orgassignments)\n- [`OrgRoles`](#orgroles)\n- [`Assignments`](#assignments)\n- [`UserId`](#userid)\n- [`OrganizationId`](#organizationid)\n- [`Slug`](#slug)\n- [`RoleSearchInput`](#rolesearchinput)\n- [`CreateRolePayload`](#createrolepayload)\n- [`Error`](#error)\n\n### `listCurrentRoles`\n\nReturns roles and grants assigned to current user\n\n`GET /v1/permissions/me`\n\n```ts\nconst { data } = await client.listCurrentRoles()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "roles": [\n {\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `listAllRoles`\n\nReturns list of all roles in organization\n\n`GET /v1/permissions/roles`\n\n```ts\nconst { data } = await client.listAllRoles()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "roles": [\n {\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createRole`\n\nCreate role\n\n`POST /v1/permissions/roles`\n\n```ts\nconst { data } = await client.createRole(\n null,\n {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n}\n```\n\n</details>\n\n---\n\n### `searchRoles`\n\nSearch Roles\n\n`POST /v1/permissions/roles:search`\n\n```ts\nconst { data } = await client.searchRoles(\n null,\n {\n role_ids: [\'123:manager\', \'456:owner\'],\n org_ids: [\'123\', \'456\'],\n slugs: [\'manager\', \'owner\'],\n query: \'Administrator\',\n limit: 1,\n offset: 1\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getRole`\n\nGet role by id\n\n`GET /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.getRole({\n roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n}\n```\n\n</details>\n\n---\n\n### `putRole`\n\nCreate or update role\n\n`PUT /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.putRole(\n {\n roleId: \'example\',\n },\n {\n id: \'123:owner\',\n name: \'Owner\',\n slug: \'owner\',\n type: \'user_role\',\n expires_at: \'2028-07-21T17:32:28Z\',\n organization_id: \'123\',\n grants: [\n {\n action: \'entity-read\',\n resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n effect: \'allow\',\n conditions: [\n {\n attribute: \'workflows.primary.task_name\',\n operation: \'equals\',\n values: [\'Qualification\']\n }\n ]\n }\n ],\n parent_role: \'123:owner\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n}\n```\n\n</details>\n\n---\n\n### `deleteRole`\n\nDelete role by id\n\n`DELETE /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.deleteRole({\n roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "123:owner",\n "name": "Owner",\n "slug": "owner",\n "type": "user_role",\n "expires_at": "2028-07-21T17:32:28Z",\n "organization_id": "123",\n "grants": [\n {\n "action": "entity-read",\n "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n "effect": "allow",\n "conditions": [\n {\n "attribute": "workflows.primary.task_name",\n "operation": "equals",\n "values": ["Qualification"]\n }\n ]\n }\n ],\n "parent_role": "123:owner"\n}\n```\n\n</details>\n\n---\n\n### `refreshPermissions`\n\nMakes sure the user has a role in the organization\n\n`GET /v1/permissions/refresh`\n\n```ts\nconst { data } = await client.refreshPermissions()\n```\n\n---\n\n### `getAssignedRolesForUser`\n\nGet list of assigned roles by user id\n\n`GET /v1/permissions/assignments/{userId}`\n\n```ts\nconst { data } = await client.getAssignedRolesForUser({\n userId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["123:owner"]\n```\n\n</details>\n\n---\n\n### `assignRoles`\n\nAssign / unassign roles to users.\n\n`PUT /v1/permissions/assignments/{userId}`\n\n```ts\nconst { data } = await client.assignRoles(\n {\n userId: \'example\',\n },\n [\'123:owner\'],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["123:owner"]\n```\n\n</details>\n\n---\n\n### `addAssignment`\n\nAssign a user to a role.\n\n`POST /v1/permissions/assignments/{userId}/{roleId}`\n\n```ts\nconst { data } = await client.addAssignment({\n userId: \'example\',\n roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "user_id": "1",\n "roles": ["123:owner"]\n}\n```\n\n</details>\n\n---\n\n### `removeAssignment`\n\nRemove role assignment from user\n\n`DELETE /v1/permissions/assignments/{userId}/{roleId}`\n\n```ts\nconst { data } = await client.removeAssignment({\n userId: \'example\',\n roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "user_id": "1",\n "roles": ["123:owner"]\n}\n```\n\n</details>\n\n---\n\n### `listAllAssignments`\n\nReturns list of all assignments in organization\n\n`GET /v1/permissions/assignments`\n\n```ts\nconst { data } = await client.listAllAssignments()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "assignments": [\n {\n "user_id": "1",\n "roles": ["123:owner"]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Grant`\n\n```ts\ntype Grant = {\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n}\n```\n\n### `GrantWithDependencies`\n\n```ts\ntype GrantWithDependencies = {\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n dependencies?: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `GrantCondition`\n\n```ts\ntype GrantCondition = object\n```\n\n### `EqualsCondition`\n\nCheck if attribute equals to any of the values\n\n```ts\ntype EqualsCondition = {\n attribute: string\n operation: "equals"\n values: unknown[]\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `BaseRole`\n\n```ts\ntype BaseRole = {\n id: string\n name: string\n slug: string\n type: string\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `BaseRoleForCreate`\n\n```ts\ntype BaseRoleForCreate = {\n id?: string\n name: string\n slug: string\n type: string\n expires_at?: string // date-time\n organization_id?: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `UserRole`\n\n```ts\ntype UserRole = {\n id: string\n name: string\n slug: string\n type: "user_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n parent_role?: object\n}\n```\n\n### `OrgRole`\n\n```ts\ntype OrgRole = {\n id: string\n name: string\n slug: string\n type: "org_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n pricing_tier?: string\n}\n```\n\n### `ShareRole`\n\n```ts\ntype ShareRole = {\n id: string\n name: string\n slug: string\n type: "share_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `PartnerRole`\n\n```ts\ntype PartnerRole = {\n id: string\n name: string\n slug: string\n type: "partner_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n partner_org_id?: object\n vendor_enforced_user_limit?: number\n}\n```\n\n### `PortalRole`\n\n```ts\ntype PortalRole = {\n id: string\n name: string\n slug: string\n type: "portal_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `Role`\n\n```ts\ntype Role = {\n id: string\n name: string\n slug: string\n type: "user_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n parent_role?: object\n} | {\n id: string\n name: string\n slug: string\n type: "org_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n pricing_tier?: string\n} | {\n id: string\n name: string\n slug: string\n type: "share_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n} | {\n id: string\n name: string\n slug: string\n type: "partner_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n partner_org_id?: object\n vendor_enforced_user_limit?: number\n} | {\n id: string\n name: string\n slug: string\n type: "portal_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n}\n```\n\n### `RolePayload`\n\n```ts\ntype RolePayload = {\n grants?: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n dependencies?: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n }>\n}\n```\n\n### `Assignment`\n\nA role attached to an user\n\n```ts\ntype Assignment = {\n user_id?: string\n roles?: string[]\n}\n```\n\n### `InternalAssignment`\n\nA role attached to an user\n\n```ts\ntype InternalAssignment = {\n userId?: string\n roles?: string[]\n}\n```\n\n### `OrgAssignments`\n\nAll roles attached to an users of an organization\n\n```ts\ntype OrgAssignments = {\n organizationId?: string\n assignments?: Array<{\n userId?: string\n roles?: string[]\n }>\n}\n```\n\n### `OrgRoles`\n\nAll roles attached to an users of an organization\n\n```ts\ntype OrgRoles = {\n organizationId?: string\n roles?: Array<{\n id: string\n name: string\n slug: string\n type: "user_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n parent_role?: object\n } | {\n id: string\n name: string\n slug: string\n type: "org_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n pricing_tier?: string\n } | {\n id: string\n name: string\n slug: string\n type: "share_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n } | {\n id: string\n name: string\n slug: string\n type: "partner_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n partner_org_id?: object\n vendor_enforced_user_limit?: number\n } | {\n id: string\n name: string\n slug: string\n type: "portal_role"\n expires_at?: string // date-time\n organization_id: string\n grants: Array<{\n action: { ... }\n resource?: { ... }\n effect?: { ... }\n conditions?: { ... }\n }>\n }>\n}\n```\n\n### `Assignments`\n\nList of role ids attached to an user\n\n```ts\ntype Assignments = string[]\n```\n\n### `UserId`\n\nId of a user\n\n```ts\ntype UserId = string\n```\n\n### `OrganizationId`\n\nId of an organization\n\n```ts\ntype OrganizationId = string\n```\n\n### `Slug`\n\nSlug of a role; for a role with id = 123:manager -> 123 is org_id & manager is slug\n\n```ts\ntype Slug = string\n```\n\n### `RoleSearchInput`\n\n```ts\ntype RoleSearchInput = {\n role_ids?: string[]\n org_ids?: string[]\n slugs?: string[]\n query?: string\n limit?: number\n offset?: number\n}\n```\n\n### `CreateRolePayload`\n\n```ts\ntype CreateRolePayload = {\n grants: Array<{\n action: string\n resource?: string\n effect?: "allow" | "deny"\n conditions?: object[]\n }>\n id?: string\n name: string\n slug: string\n type: string\n expires_at?: string // date-time\n organization_id?: string\n}\n```\n\n### `Error`\n\nError response\n\n```ts\ntype Error = {\n message: string\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = permissions_default;
|