@epilot/sdk 2.0.0-beta.4 → 2.0.3
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/LICENSE +21 -0
- package/dist/{access-token.d-BuXO-21p.d.cts → access-token.d-CnmUTOlq.d.cts} +1 -1
- package/dist/{access-token.d-BuXO-21p.d.ts → access-token.d-CnmUTOlq.d.ts} +1 -1
- package/dist/{address-suggestions.d-Cay0qOfA.d.cts → address-suggestions.d-_YwTOR-9.d.cts} +1 -1
- package/dist/{address-suggestions.d-Cay0qOfA.d.ts → address-suggestions.d-_YwTOR-9.d.ts} +1 -1
- package/dist/{address.d-D-oZY0rk.d.cts → address.d-CwAPOVxa.d.cts} +1 -1
- package/dist/{address.d-D-oZY0rk.d.ts → address.d-CwAPOVxa.d.ts} +1 -1
- package/dist/{ai-agents.d-B4_CZTCP.d.cts → ai-agents.d-OkXfr2bz.d.cts} +1 -1
- package/dist/{ai-agents.d-B4_CZTCP.d.ts → ai-agents.d-OkXfr2bz.d.ts} +1 -1
- package/dist/apis/access-token.d.cts +3 -3
- package/dist/apis/access-token.d.ts +3 -3
- package/dist/apis/address-suggestions.d.cts +3 -3
- package/dist/apis/address-suggestions.d.ts +3 -3
- package/dist/apis/address.d.cts +3 -3
- package/dist/apis/address.d.ts +3 -3
- package/dist/apis/ai-agents.d.cts +3 -3
- package/dist/apis/ai-agents.d.ts +3 -3
- package/dist/apis/app.d.cts +3 -3
- package/dist/apis/app.d.ts +3 -3
- package/dist/apis/audit-logs.d.cts +3 -3
- package/dist/apis/audit-logs.d.ts +3 -3
- package/dist/apis/automation.d.cts +3 -3
- package/dist/apis/automation.d.ts +3 -3
- package/dist/apis/billing.d.cts +3 -3
- package/dist/apis/billing.d.ts +3 -3
- package/dist/apis/blueprint-manifest.d.cts +3 -3
- package/dist/apis/blueprint-manifest.d.ts +3 -3
- package/dist/apis/consent.d.cts +3 -3
- package/dist/apis/consent.d.ts +3 -3
- package/dist/apis/customer-portal.cjs +1 -1
- package/dist/apis/customer-portal.d.cts +3 -3
- package/dist/apis/customer-portal.d.ts +3 -3
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.d.cts +3 -3
- package/dist/apis/dashboard.d.ts +3 -3
- package/dist/apis/data-management.d.cts +3 -3
- package/dist/apis/data-management.d.ts +3 -3
- package/dist/apis/deduplication.d.cts +3 -3
- package/dist/apis/deduplication.d.ts +3 -3
- package/dist/apis/design.d.cts +3 -3
- package/dist/apis/design.d.ts +3 -3
- package/dist/apis/document.d.cts +3 -3
- package/dist/apis/document.d.ts +3 -3
- package/dist/apis/email-settings.d.cts +3 -3
- package/dist/apis/email-settings.d.ts +3 -3
- package/dist/apis/email-template.d.cts +3 -3
- package/dist/apis/email-template.d.ts +3 -3
- package/dist/apis/entity-mapping.d.cts +3 -3
- package/dist/apis/entity-mapping.d.ts +3 -3
- package/dist/apis/entity.d.cts +3 -3
- package/dist/apis/entity.d.ts +3 -3
- package/dist/apis/environments.d.cts +3 -3
- package/dist/apis/environments.d.ts +3 -3
- package/dist/apis/erp-integration.cjs +1 -1
- package/dist/apis/erp-integration.d.cts +3 -3
- package/dist/apis/erp-integration.d.ts +3 -3
- package/dist/apis/erp-integration.js +1 -1
- package/dist/apis/event-catalog.d.cts +3 -3
- package/dist/apis/event-catalog.d.ts +3 -3
- package/dist/apis/file.d.cts +3 -3
- package/dist/apis/file.d.ts +3 -3
- package/dist/apis/iban.d.cts +3 -3
- package/dist/apis/iban.d.ts +3 -3
- package/dist/apis/journey.d.cts +3 -3
- package/dist/apis/journey.d.ts +3 -3
- package/dist/apis/kanban.d.cts +3 -3
- package/dist/apis/kanban.d.ts +3 -3
- package/dist/apis/message.d.cts +3 -3
- package/dist/apis/message.d.ts +3 -3
- package/dist/apis/metering.d.cts +3 -3
- package/dist/apis/metering.d.ts +3 -3
- package/dist/apis/notes.d.cts +3 -3
- package/dist/apis/notes.d.ts +3 -3
- package/dist/apis/notification.d.cts +3 -3
- package/dist/apis/notification.d.ts +3 -3
- package/dist/apis/organization.cjs +1 -1
- package/dist/apis/organization.d.cts +3 -3
- package/dist/apis/organization.d.ts +3 -3
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.d.cts +3 -3
- package/dist/apis/partner-directory.d.ts +3 -3
- package/dist/apis/permissions.d.cts +3 -3
- package/dist/apis/permissions.d.ts +3 -3
- package/dist/apis/pricing-tier.d.cts +3 -3
- package/dist/apis/pricing-tier.d.ts +3 -3
- package/dist/apis/pricing.d.cts +3 -3
- package/dist/apis/pricing.d.ts +3 -3
- package/dist/apis/purpose.d.cts +3 -3
- package/dist/apis/purpose.d.ts +3 -3
- package/dist/apis/sandbox.d.cts +3 -3
- package/dist/apis/sandbox.d.ts +3 -3
- package/dist/apis/submission.d.cts +3 -3
- package/dist/apis/submission.d.ts +3 -3
- package/dist/apis/targeting.d.cts +3 -3
- package/dist/apis/targeting.d.ts +3 -3
- package/dist/apis/template-variables.d.cts +3 -3
- package/dist/apis/template-variables.d.ts +3 -3
- package/dist/apis/user.d.cts +3 -3
- package/dist/apis/user.d.ts +3 -3
- package/dist/apis/validation-rules.d.cts +3 -3
- package/dist/apis/validation-rules.d.ts +3 -3
- package/dist/apis/webhooks.d.cts +3 -3
- package/dist/apis/webhooks.d.ts +3 -3
- package/dist/apis/workflow-definition.d.cts +3 -3
- package/dist/apis/workflow-definition.d.ts +3 -3
- package/dist/apis/workflow.d.cts +3 -3
- package/dist/apis/workflow.d.ts +3 -3
- package/dist/{app.d-BKyfin-q.d.cts → app.d-Dr03n4J4.d.cts} +1 -1
- package/dist/{app.d-BKyfin-q.d.ts → app.d-Dr03n4J4.d.ts} +1 -1
- package/dist/{audit-logs.d-19BKb-ur.d.cts → audit-logs.d-BRToFqeX.d.cts} +1 -1
- package/dist/{audit-logs.d-19BKb-ur.d.ts → audit-logs.d-BRToFqeX.d.ts} +1 -1
- package/dist/{automation.d-DKl2VtnW.d.ts → automation.d-KOiZ6ru5.d.cts} +2 -24
- package/dist/{automation.d-DKl2VtnW.d.cts → automation.d-KOiZ6ru5.d.ts} +2 -24
- package/dist/{billing.d-58fUMBqj.d.cts → billing.d-Bs8Ku9qE.d.cts} +1 -1
- package/dist/{billing.d-58fUMBqj.d.ts → billing.d-Bs8Ku9qE.d.ts} +1 -1
- package/dist/{blueprint-manifest.d-Bu1GyXFW.d.cts → blueprint-manifest.d-CEWRdF3i.d.cts} +1 -1
- package/dist/{blueprint-manifest.d-Bu1GyXFW.d.ts → blueprint-manifest.d-CEWRdF3i.d.ts} +1 -1
- package/dist/{consent.d-CQ88IEj0.d.cts → consent.d-C2PROHhX.d.cts} +1 -1
- package/dist/{consent.d-CQ88IEj0.d.ts → consent.d-C2PROHhX.d.ts} +1 -1
- package/dist/{customer-portal.d-EyndRWh6.d.ts → customer-portal.d-Bh9NF8cY.d.cts} +598 -99
- package/dist/{customer-portal.d-EyndRWh6.d.cts → customer-portal.d-Bh9NF8cY.d.ts} +598 -99
- package/dist/{dashboard.d-AE3RQ6zo.d.cts → dashboard.d-CsGcA74I.d.cts} +1 -1
- package/dist/{dashboard.d-AE3RQ6zo.d.ts → dashboard.d-CsGcA74I.d.ts} +1 -1
- package/dist/{data-management.d-CNExsqJQ.d.cts → data-management.d-pnuiRU2h.d.cts} +1 -1
- package/dist/{data-management.d-CNExsqJQ.d.ts → data-management.d-pnuiRU2h.d.ts} +1 -1
- package/dist/{deduplication.d-DCeJzdbM.d.ts → deduplication.d-w_2aJD5f.d.cts} +1 -1
- package/dist/{deduplication.d-DCeJzdbM.d.cts → deduplication.d-w_2aJD5f.d.ts} +1 -1
- package/dist/{design.d-CkwgJ78Z.d.cts → design.d-eA-irKEX.d.cts} +1 -1
- package/dist/{design.d-CkwgJ78Z.d.ts → design.d-eA-irKEX.d.ts} +1 -1
- package/dist/{document.d-Y8i32qNV.d.cts → document.d-DN37pjdx.d.cts} +1 -1
- package/dist/{document.d-Y8i32qNV.d.ts → document.d-DN37pjdx.d.ts} +1 -1
- package/dist/{email-settings.d-CPAsRFWN.d.cts → email-settings.d-BXxYjVDr.d.cts} +1 -1
- package/dist/{email-settings.d-CPAsRFWN.d.ts → email-settings.d-BXxYjVDr.d.ts} +1 -1
- package/dist/{email-template.d-CQqiCN0N.d.cts → email-template.d-BeqkDHtk.d.cts} +1 -1
- package/dist/{email-template.d-CQqiCN0N.d.ts → email-template.d-BeqkDHtk.d.ts} +1 -1
- package/dist/{entity-mapping.d-DiqXqJWb.d.cts → entity-mapping.d-DKSW3sfy.d.cts} +1 -1
- package/dist/{entity-mapping.d-DiqXqJWb.d.ts → entity-mapping.d-DKSW3sfy.d.ts} +1 -1
- package/dist/{entity.d-BtT4mdq4.d.ts → entity.d-CrtZaZr8.d.cts} +1 -1
- package/dist/{entity.d-BtT4mdq4.d.cts → entity.d-CrtZaZr8.d.ts} +1 -1
- package/dist/{environments.d-C1xIs8N2.d.cts → environments.d-H3LK_KuH.d.cts} +1 -1
- package/dist/{environments.d-C1xIs8N2.d.ts → environments.d-H3LK_KuH.d.ts} +1 -1
- package/dist/{erp-integration.d-CNLzgl4L.d.cts → erp-integration.d-DOhxy4P5.d.cts} +409 -15
- package/dist/{erp-integration.d-CNLzgl4L.d.ts → erp-integration.d-DOhxy4P5.d.ts} +409 -15
- package/dist/{event-catalog.d-DW1dOyVh.d.cts → event-catalog.d-ENw6HO-w.d.cts} +1 -1
- package/dist/{event-catalog.d-DW1dOyVh.d.ts → event-catalog.d-ENw6HO-w.d.ts} +1 -1
- package/dist/{file.d-Bpdt2ORN.d.cts → file.d-DcTJxjp7.d.cts} +1 -1
- package/dist/{file.d-Bpdt2ORN.d.ts → file.d-DcTJxjp7.d.ts} +1 -1
- package/dist/{iban.d-3_7FEsbx.d.ts → iban.d-BwdiGbxi.d.cts} +1 -1
- package/dist/{iban.d-3_7FEsbx.d.cts → iban.d-BwdiGbxi.d.ts} +1 -1
- package/dist/index.d.cts +46 -46
- package/dist/index.d.ts +46 -46
- package/dist/{journey.d-C2lgynUF.d.cts → journey.d-C4N4t1Rh.d.cts} +122 -4
- package/dist/{journey.d-C2lgynUF.d.ts → journey.d-C4N4t1Rh.d.ts} +122 -4
- package/dist/kanban.d-CtSt3uX2.d.cts +745 -0
- package/dist/kanban.d-CtSt3uX2.d.ts +745 -0
- package/dist/{message.d-TAVDRlDJ.d.cts → message.d-YEv1kmQd.d.cts} +1 -1
- package/dist/{message.d-TAVDRlDJ.d.ts → message.d-YEv1kmQd.d.ts} +1 -1
- package/dist/{metering.d-qyYaAU-O.d.cts → metering.d-DvtPv7wk.d.cts} +1 -1
- package/dist/{metering.d-qyYaAU-O.d.ts → metering.d-DvtPv7wk.d.ts} +1 -1
- package/dist/{notes.d-CDyIbegf.d.cts → notes.d-BC-scR42.d.cts} +1 -1
- package/dist/{notes.d-CDyIbegf.d.ts → notes.d-BC-scR42.d.ts} +1 -1
- package/dist/{notification.d-B7ccbaPr.d.cts → notification.d-BfBL3lga.d.cts} +1 -1
- package/dist/{notification.d-B7ccbaPr.d.ts → notification.d-BfBL3lga.d.ts} +1 -1
- package/dist/organization.d-Bd2Hmk8v.d.cts +1244 -0
- package/dist/organization.d-Bd2Hmk8v.d.ts +1244 -0
- package/dist/{partner-directory.d-CzKV3WfP.d.cts → partner-directory.d-CRNkDF8q.d.cts} +1 -1
- package/dist/{partner-directory.d-CzKV3WfP.d.ts → partner-directory.d-CRNkDF8q.d.ts} +1 -1
- package/dist/{permissions.d-lVoPAfl3.d.cts → permissions.d-BHB1FFS5.d.cts} +1 -1
- package/dist/{permissions.d-lVoPAfl3.d.ts → permissions.d-BHB1FFS5.d.ts} +1 -1
- package/dist/{pricing-tier.d-BW2cZt1w.d.cts → pricing-tier.d-Cg0jl6n_.d.cts} +1 -1
- package/dist/{pricing-tier.d-BW2cZt1w.d.ts → pricing-tier.d-Cg0jl6n_.d.ts} +1 -1
- package/dist/{pricing.d-Ehb2JuKY.d.cts → pricing.d-Cv39plGm.d.cts} +1 -1
- package/dist/{pricing.d-Ehb2JuKY.d.ts → pricing.d-Cv39plGm.d.ts} +1 -1
- package/dist/{purpose.d-BVxst611.d.cts → purpose.d-CbIYfTua.d.cts} +1 -1
- package/dist/{purpose.d-BVxst611.d.ts → purpose.d-CbIYfTua.d.ts} +1 -1
- package/dist/{sandbox.d-tRO2movo.d.cts → sandbox.d-BdbOFzDu.d.cts} +1 -1
- package/dist/{sandbox.d-tRO2movo.d.ts → sandbox.d-BdbOFzDu.d.ts} +1 -1
- package/dist/{submission.d-CSll5Km9.d.cts → submission.d-BamwfhXw.d.cts} +1 -1
- package/dist/{submission.d-CSll5Km9.d.ts → submission.d-BamwfhXw.d.ts} +1 -1
- package/dist/{targeting.d-CDxIsOWy.d.cts → targeting.d-BNmcVsNS.d.cts} +1 -1
- package/dist/{targeting.d-CDxIsOWy.d.ts → targeting.d-BNmcVsNS.d.ts} +1 -1
- package/dist/{template-variables.d-PwA27Ocv.d.cts → template-variables.d-Ch3H3zYf.d.cts} +1 -1
- package/dist/{template-variables.d-PwA27Ocv.d.ts → template-variables.d-Ch3H3zYf.d.ts} +1 -1
- package/dist/{user.d-DJBp6aX5.d.cts → user.d-CXqM751M.d.cts} +1 -1
- package/dist/{user.d-DJBp6aX5.d.ts → user.d-CXqM751M.d.ts} +1 -1
- package/dist/{validation-rules.d-CScjNdxD.d.cts → validation-rules.d-Db5c5zTf.d.cts} +1 -1
- package/dist/{validation-rules.d-CScjNdxD.d.ts → validation-rules.d-Db5c5zTf.d.ts} +1 -1
- package/dist/{webhooks.d-C_MQSJEB.d.cts → webhooks.d-CUNJrltY.d.cts} +1 -1
- package/dist/{webhooks.d-C_MQSJEB.d.ts → webhooks.d-CUNJrltY.d.ts} +1 -1
- package/dist/{workflow-definition.d-CFXrp2Hg.d.cts → workflow-definition.d-CE3kk9gl.d.cts} +1 -1
- package/dist/{workflow-definition.d-CFXrp2Hg.d.ts → workflow-definition.d-CE3kk9gl.d.ts} +1 -1
- package/dist/{workflow.d-BIWtgMyP.d.cts → workflow.d-DvhTpEtU.d.cts} +46 -4
- package/dist/{workflow.d-BIWtgMyP.d.ts → workflow.d-DvhTpEtU.d.ts} +46 -4
- package/package.json +152 -11
- package/definitions/access-token-runtime.json +0 -1
- package/definitions/access-token.json +0 -663
- package/definitions/address-runtime.json +0 -1
- package/definitions/address-suggestions-runtime.json +0 -1
- package/definitions/address-suggestions.json +0 -582
- package/definitions/address.json +0 -578
- package/definitions/ai-agents-runtime.json +0 -1
- package/definitions/ai-agents.json +0 -1711
- package/definitions/app-runtime.json +0 -1
- package/definitions/app.json +0 -4443
- package/definitions/audit-logs-runtime.json +0 -1
- package/definitions/audit-logs.json +0 -305
- package/definitions/automation-runtime.json +0 -1
- package/definitions/automation.json +0 -4850
- package/definitions/billing-runtime.json +0 -1
- package/definitions/billing.json +0 -837
- package/definitions/blueprint-manifest-runtime.json +0 -1
- package/definitions/blueprint-manifest.json +0 -3376
- package/definitions/consent-runtime.json +0 -1
- package/definitions/consent.json +0 -344
- package/definitions/customer-portal-runtime.json +0 -1
- package/definitions/customer-portal.json +0 -15000
- package/definitions/dashboard-runtime.json +0 -1
- package/definitions/dashboard.json +0 -484
- package/definitions/data-management-runtime.json +0 -1
- package/definitions/data-management.json +0 -962
- package/definitions/deduplication-runtime.json +0 -1
- package/definitions/deduplication.json +0 -183
- package/definitions/design-runtime.json +0 -1
- package/definitions/design.json +0 -1423
- package/definitions/document-runtime.json +0 -1
- package/definitions/document.json +0 -758
- package/definitions/email-settings-runtime.json +0 -1
- package/definitions/email-settings.json +0 -2627
- package/definitions/email-template-runtime.json +0 -1
- package/definitions/email-template.json +0 -1419
- package/definitions/entity-mapping-runtime.json +0 -1
- package/definitions/entity-mapping.json +0 -1642
- package/definitions/entity-runtime.json +0 -1
- package/definitions/entity.json +0 -10074
- package/definitions/environments-runtime.json +0 -1
- package/definitions/environments.json +0 -363
- package/definitions/erp-integration-runtime.json +0 -1
- package/definitions/erp-integration.json +0 -5845
- package/definitions/event-catalog-runtime.json +0 -1
- package/definitions/event-catalog.json +0 -1051
- package/definitions/file-runtime.json +0 -1
- package/definitions/file.json +0 -2842
- package/definitions/iban-runtime.json +0 -1
- package/definitions/iban.json +0 -132
- package/definitions/journey-runtime.json +0 -1
- package/definitions/journey.json +0 -2341
- package/definitions/kanban-runtime.json +0 -1
- package/definitions/kanban.json +0 -929
- package/definitions/message-runtime.json +0 -1
- package/definitions/message.json +0 -2660
- package/definitions/metering-runtime.json +0 -1
- package/definitions/metering.json +0 -2321
- package/definitions/notes-runtime.json +0 -1
- package/definitions/notes.json +0 -1531
- package/definitions/notification-runtime.json +0 -1
- package/definitions/notification.json +0 -1425
- package/definitions/organization-runtime.json +0 -1
- package/definitions/organization.json +0 -629
- package/definitions/partner-directory-runtime.json +0 -1
- package/definitions/partner-directory.json +0 -1718
- package/definitions/permissions-runtime.json +0 -1
- package/definitions/permissions.json +0 -1480
- package/definitions/pricing-runtime.json +0 -1
- package/definitions/pricing-tier-runtime.json +0 -1
- package/definitions/pricing-tier.json +0 -105
- package/definitions/pricing.json +0 -9884
- package/definitions/purpose-runtime.json +0 -1
- package/definitions/purpose.json +0 -524
- package/definitions/sandbox-runtime.json +0 -1
- package/definitions/sandbox.json +0 -453
- package/definitions/submission-runtime.json +0 -1
- package/definitions/submission.json +0 -313
- package/definitions/targeting-runtime.json +0 -1
- package/definitions/targeting.json +0 -1474
- package/definitions/template-variables-runtime.json +0 -1
- package/definitions/template-variables.json +0 -1408
- package/definitions/user-runtime.json +0 -1
- package/definitions/user.json +0 -2408
- package/definitions/validation-rules-runtime.json +0 -1
- package/definitions/validation-rules.json +0 -1491
- package/definitions/webhooks-runtime.json +0 -1
- package/definitions/webhooks.json +0 -1525
- package/definitions/workflow-definition-runtime.json +0 -1
- package/definitions/workflow-definition.json +0 -3417
- package/definitions/workflow-runtime.json +0 -1
- package/definitions/workflow.json +0 -4106
- package/dist/kanban.d-DYVjUQ_S.d.cts +0 -630
- package/dist/kanban.d-DYVjUQ_S.d.ts +0 -630
- package/dist/organization.d-BxZWnh8L.d.cts +0 -628
- package/dist/organization.d-BxZWnh8L.d.ts +0 -628
|
@@ -0,0 +1,1244 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* Auto-copied from organization-client */
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
declare namespace Components {
|
|
7
|
+
namespace Schemas {
|
|
8
|
+
/**
|
|
9
|
+
* Request payload for creating a new organization
|
|
10
|
+
*/
|
|
11
|
+
export interface CreateOrganizationRequest {
|
|
12
|
+
/**
|
|
13
|
+
* Core organization information for the new tenant
|
|
14
|
+
*/
|
|
15
|
+
organization_detail?: {
|
|
16
|
+
/**
|
|
17
|
+
* Display name for the organization
|
|
18
|
+
* example:
|
|
19
|
+
* epilot
|
|
20
|
+
*/
|
|
21
|
+
name: string;
|
|
22
|
+
/**
|
|
23
|
+
* Primary contact email for the organization
|
|
24
|
+
* example:
|
|
25
|
+
* epilot@epilot.cloud
|
|
26
|
+
*/
|
|
27
|
+
email_address?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Organization type classification.
|
|
30
|
+
* - Vendor: Primary organization type for epilot customers
|
|
31
|
+
* - Partner: Partner organization type
|
|
32
|
+
*
|
|
33
|
+
* example:
|
|
34
|
+
* Vendor
|
|
35
|
+
*/
|
|
36
|
+
type: string;
|
|
37
|
+
/**
|
|
38
|
+
* Whether this is a production or sandbox environment.
|
|
39
|
+
* Sandbox organizations are for testing and linked to a production org.
|
|
40
|
+
*
|
|
41
|
+
*/
|
|
42
|
+
organization_use?: "Production" | "Sandbox";
|
|
43
|
+
/**
|
|
44
|
+
* The ULID of the pricing tier to assign to this organization.
|
|
45
|
+
* Determines feature access and billing.
|
|
46
|
+
*
|
|
47
|
+
* example:
|
|
48
|
+
* 01GEKHZHSN19KK10ZS92Y3WY9B
|
|
49
|
+
*/
|
|
50
|
+
pricing_tier_id: string;
|
|
51
|
+
};
|
|
52
|
+
/**
|
|
53
|
+
* Initial owner user details.
|
|
54
|
+
* This user will receive an invitation email to complete registration
|
|
55
|
+
* and become the organization administrator.
|
|
56
|
+
*
|
|
57
|
+
*/
|
|
58
|
+
owner_user?: {
|
|
59
|
+
/**
|
|
60
|
+
* Full name of the owner user
|
|
61
|
+
* example:
|
|
62
|
+
* Ny Huynh
|
|
63
|
+
*/
|
|
64
|
+
full_name?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Email address for the invitation (must be unique in the platform)
|
|
67
|
+
* example:
|
|
68
|
+
* ny.huynhthi@axonactive.com
|
|
69
|
+
*/
|
|
70
|
+
email_address: string;
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Data point metrics for a single organization, used for usage tracking and billing
|
|
75
|
+
*/
|
|
76
|
+
export interface DataPoint {
|
|
77
|
+
/**
|
|
78
|
+
* The organization ID (numeric format)
|
|
79
|
+
* example:
|
|
80
|
+
* 206801
|
|
81
|
+
*/
|
|
82
|
+
id?: number;
|
|
83
|
+
/**
|
|
84
|
+
* Maximum number of customer entities recorded in the previous month.
|
|
85
|
+
* Used as a high-water mark for billing calculations.
|
|
86
|
+
*
|
|
87
|
+
* example:
|
|
88
|
+
* 10
|
|
89
|
+
*/
|
|
90
|
+
max_customer?: number;
|
|
91
|
+
/**
|
|
92
|
+
* Current count of customer entities in the organization.
|
|
93
|
+
* Represents the actual usage at the time of the query.
|
|
94
|
+
*
|
|
95
|
+
* example:
|
|
96
|
+
* 10
|
|
97
|
+
*/
|
|
98
|
+
actual_customer?: number;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* List of data point metrics for all organizations
|
|
102
|
+
*/
|
|
103
|
+
export type DataPointsResponse = /* Data point metrics for a single organization, used for usage tracking and billing */ DataPoint[];
|
|
104
|
+
/**
|
|
105
|
+
* Metadata for a single feature flag toggle
|
|
106
|
+
*/
|
|
107
|
+
export interface FeatureFlagMetadata {
|
|
108
|
+
/**
|
|
109
|
+
* Unique identifier matching the organization setting key
|
|
110
|
+
* example:
|
|
111
|
+
* canary
|
|
112
|
+
*/
|
|
113
|
+
feature_name: string;
|
|
114
|
+
title?: /* Internationalized string with a translation key and optional default value */ I18nString;
|
|
115
|
+
description?: /* Internationalized string with a translation key and optional default value */ I18nString;
|
|
116
|
+
/**
|
|
117
|
+
* Badge label shown next to the feature toggle
|
|
118
|
+
*/
|
|
119
|
+
badge?: "alpha" | "beta" | "new" | "advanced" | "experiment" | "deprecated";
|
|
120
|
+
/**
|
|
121
|
+
* Whether to show confetti animation when enabled
|
|
122
|
+
*/
|
|
123
|
+
confetti?: boolean;
|
|
124
|
+
/**
|
|
125
|
+
* Whether the toggle can only be turned on (not off)
|
|
126
|
+
*/
|
|
127
|
+
one_way?: boolean;
|
|
128
|
+
/**
|
|
129
|
+
* Whether the toggle value is inverted (checked = disabled)
|
|
130
|
+
*/
|
|
131
|
+
reverse_checked?: boolean;
|
|
132
|
+
/**
|
|
133
|
+
* Whether this feature is visible for partner organizations
|
|
134
|
+
*/
|
|
135
|
+
is_visible_for_partner?: boolean;
|
|
136
|
+
/**
|
|
137
|
+
* Rules that must ALL pass for this feature to be visible (implicit AND)
|
|
138
|
+
*/
|
|
139
|
+
visibility_rules: /**
|
|
140
|
+
* A rule that determines feature visibility. Rules are combined with AND logic
|
|
141
|
+
* at the top level. Supports boolean combinators (and, or, not) for complex logic.
|
|
142
|
+
*
|
|
143
|
+
*/
|
|
144
|
+
VisibilityRule[];
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* Feature settings metadata served to frontend applications.
|
|
148
|
+
*/
|
|
149
|
+
export interface FeatureSettings {
|
|
150
|
+
/**
|
|
151
|
+
* Schema version for backwards compatibility
|
|
152
|
+
* example:
|
|
153
|
+
* 1.0.0
|
|
154
|
+
*/
|
|
155
|
+
version: string;
|
|
156
|
+
/**
|
|
157
|
+
* Feature flag metadata for the settings page
|
|
158
|
+
*/
|
|
159
|
+
feature_flags: /* Metadata for a single feature flag toggle */ FeatureFlagMetadata[];
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* Response containing a list of HubSpot companies matching the search criteria
|
|
163
|
+
*/
|
|
164
|
+
export interface HubspotCompaniesResponse {
|
|
165
|
+
/**
|
|
166
|
+
* List of HubSpot companies matching the query
|
|
167
|
+
*/
|
|
168
|
+
results?: /**
|
|
169
|
+
* Represents a company record from HubSpot CRM synchronized to the epilot data warehouse.
|
|
170
|
+
* Used for CRM integration and organization mapping.
|
|
171
|
+
*
|
|
172
|
+
*/
|
|
173
|
+
HubspotCompany[];
|
|
174
|
+
/**
|
|
175
|
+
* Total number of companies in the response
|
|
176
|
+
* example:
|
|
177
|
+
* 10
|
|
178
|
+
*/
|
|
179
|
+
total?: number;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Represents a company record from HubSpot CRM synchronized to the epilot data warehouse.
|
|
183
|
+
* Used for CRM integration and organization mapping.
|
|
184
|
+
*
|
|
185
|
+
*/
|
|
186
|
+
export interface HubspotCompany {
|
|
187
|
+
/**
|
|
188
|
+
* The unique HubSpot company identifier
|
|
189
|
+
* example:
|
|
190
|
+
* 12345678901
|
|
191
|
+
*/
|
|
192
|
+
company_id?: string;
|
|
193
|
+
/**
|
|
194
|
+
* The display name of the company in HubSpot
|
|
195
|
+
* example:
|
|
196
|
+
* Acme Corp
|
|
197
|
+
*/
|
|
198
|
+
company_name?: string | null;
|
|
199
|
+
/**
|
|
200
|
+
* The primary web domain associated with the company
|
|
201
|
+
* example:
|
|
202
|
+
* acme.com
|
|
203
|
+
*/
|
|
204
|
+
domain?: string | null;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* HubSpot company data associated with an epilot organization.
|
|
208
|
+
* Contains business metrics and CRM properties synced from HubSpot.
|
|
209
|
+
*
|
|
210
|
+
*/
|
|
211
|
+
export interface HubspotOrganizationData {
|
|
212
|
+
/**
|
|
213
|
+
* The unique HubSpot company identifier
|
|
214
|
+
* example:
|
|
215
|
+
* 5278308807
|
|
216
|
+
*/
|
|
217
|
+
company_id?: string;
|
|
218
|
+
/**
|
|
219
|
+
* The display name of the company in HubSpot
|
|
220
|
+
* example:
|
|
221
|
+
* Stadtwerke Meerbusch Willich Netz
|
|
222
|
+
*/
|
|
223
|
+
company_name?: string | null;
|
|
224
|
+
/**
|
|
225
|
+
* The primary web domain associated with the company
|
|
226
|
+
* example:
|
|
227
|
+
* stadtwerke-service.de
|
|
228
|
+
*/
|
|
229
|
+
domain?: string | null;
|
|
230
|
+
/**
|
|
231
|
+
* Current Monthly Recurring Revenue
|
|
232
|
+
* example:
|
|
233
|
+
* 11033.33
|
|
234
|
+
*/
|
|
235
|
+
current_mrr?: string | null;
|
|
236
|
+
/**
|
|
237
|
+
* Potential Monthly Recurring Revenue
|
|
238
|
+
* example:
|
|
239
|
+
* 20000
|
|
240
|
+
*/
|
|
241
|
+
potential_mrr?: string | null;
|
|
242
|
+
/**
|
|
243
|
+
* Company size classification
|
|
244
|
+
* example:
|
|
245
|
+
* Large
|
|
246
|
+
*/
|
|
247
|
+
company_size?: string | null;
|
|
248
|
+
/**
|
|
249
|
+
* Current pricing tier
|
|
250
|
+
* example:
|
|
251
|
+
* Professional
|
|
252
|
+
*/
|
|
253
|
+
pricing_tier?: string | null;
|
|
254
|
+
/**
|
|
255
|
+
* HubSpot lifecycle stage
|
|
256
|
+
* example:
|
|
257
|
+
* customer
|
|
258
|
+
*/
|
|
259
|
+
lifecyclestage?: string | null;
|
|
260
|
+
/**
|
|
261
|
+
* Industry classification
|
|
262
|
+
* example:
|
|
263
|
+
* Energiedienstleister
|
|
264
|
+
*/
|
|
265
|
+
industry?: string | null;
|
|
266
|
+
/**
|
|
267
|
+
* Number of employees
|
|
268
|
+
* example:
|
|
269
|
+
* 200
|
|
270
|
+
*/
|
|
271
|
+
numberofemployees?: string | null;
|
|
272
|
+
/**
|
|
273
|
+
* epilot customer number
|
|
274
|
+
* example:
|
|
275
|
+
* 10031
|
|
276
|
+
*/
|
|
277
|
+
customer_number?: string | null;
|
|
278
|
+
/**
|
|
279
|
+
* Number of active users
|
|
280
|
+
* example:
|
|
281
|
+
* 34
|
|
282
|
+
*/
|
|
283
|
+
no_of_users?: string | null;
|
|
284
|
+
/**
|
|
285
|
+
* User activation rate
|
|
286
|
+
* example:
|
|
287
|
+
* 0.647059
|
|
288
|
+
*/
|
|
289
|
+
activation_rate?: string | null;
|
|
290
|
+
/**
|
|
291
|
+
* List of active features
|
|
292
|
+
* example:
|
|
293
|
+
* Installer Portal
|
|
294
|
+
*/
|
|
295
|
+
active_features?: string | null;
|
|
296
|
+
/**
|
|
297
|
+
* Implemented use cases
|
|
298
|
+
* example:
|
|
299
|
+
* GRID: Installations (MGA);GRID: House Connections
|
|
300
|
+
*/
|
|
301
|
+
usecases_implemented?: string | null;
|
|
302
|
+
/**
|
|
303
|
+
* Current buyer's journey stage
|
|
304
|
+
* example:
|
|
305
|
+
* Expansion-Ready
|
|
306
|
+
*/
|
|
307
|
+
buyer_journey?: string | null;
|
|
308
|
+
/**
|
|
309
|
+
* Company country
|
|
310
|
+
* example:
|
|
311
|
+
* Germany
|
|
312
|
+
*/
|
|
313
|
+
country?: string | null;
|
|
314
|
+
/**
|
|
315
|
+
* Company city
|
|
316
|
+
* example:
|
|
317
|
+
* Willich
|
|
318
|
+
*/
|
|
319
|
+
city?: string | null;
|
|
320
|
+
/**
|
|
321
|
+
* Full HubSpot properties object with all available fields
|
|
322
|
+
*/
|
|
323
|
+
properties?: {
|
|
324
|
+
[name: string]: any;
|
|
325
|
+
};
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* Internationalized string with a translation key and optional default value
|
|
329
|
+
*/
|
|
330
|
+
export interface I18nString {
|
|
331
|
+
/**
|
|
332
|
+
* Translation key for i18n lookup
|
|
333
|
+
* example:
|
|
334
|
+
* canary_setting.title
|
|
335
|
+
*/
|
|
336
|
+
key: string;
|
|
337
|
+
/**
|
|
338
|
+
* Fallback value when translation is not available
|
|
339
|
+
* example:
|
|
340
|
+
* Canary Updates
|
|
341
|
+
*/
|
|
342
|
+
default_value?: string;
|
|
343
|
+
}
|
|
344
|
+
/**
|
|
345
|
+
* Extended organization object with internal-only fields.
|
|
346
|
+
*
|
|
347
|
+
* Includes all fields from the base Organization schema plus additional
|
|
348
|
+
* internal metadata used for platform administration and support.
|
|
349
|
+
*
|
|
350
|
+
*/
|
|
351
|
+
export interface InternalOrganization {
|
|
352
|
+
id?: /**
|
|
353
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
354
|
+
* example:
|
|
355
|
+
* 739224
|
|
356
|
+
*/
|
|
357
|
+
OrganizationId;
|
|
358
|
+
/**
|
|
359
|
+
* Organization name
|
|
360
|
+
* example:
|
|
361
|
+
* Epilot
|
|
362
|
+
*/
|
|
363
|
+
name?: string | null;
|
|
364
|
+
/**
|
|
365
|
+
* Organization contact email
|
|
366
|
+
* example:
|
|
367
|
+
* someone@epilot.cloud
|
|
368
|
+
*/
|
|
369
|
+
email?: string | null;
|
|
370
|
+
/**
|
|
371
|
+
* Organization contact phone
|
|
372
|
+
* example:
|
|
373
|
+
* +49123123123
|
|
374
|
+
*/
|
|
375
|
+
phone?: string | null;
|
|
376
|
+
/**
|
|
377
|
+
* Organization website
|
|
378
|
+
* example:
|
|
379
|
+
* https://epilot.cloud
|
|
380
|
+
*/
|
|
381
|
+
website?: string | null;
|
|
382
|
+
/**
|
|
383
|
+
* Organization postal address
|
|
384
|
+
*/
|
|
385
|
+
address?: {
|
|
386
|
+
[name: string]: any;
|
|
387
|
+
country?: string | null;
|
|
388
|
+
city?: string | null;
|
|
389
|
+
postal_code?: string | null;
|
|
390
|
+
street?: string | null;
|
|
391
|
+
street_number?: string | null;
|
|
392
|
+
};
|
|
393
|
+
/**
|
|
394
|
+
* Indicates whether this is a production or sandbox organization.
|
|
395
|
+
* Sandbox organizations are linked to a parent production organization for testing purposes.
|
|
396
|
+
*
|
|
397
|
+
*/
|
|
398
|
+
organization_use?: "Production" | "Sandbox";
|
|
399
|
+
/**
|
|
400
|
+
* The ID of the parent production organization.
|
|
401
|
+
* Only set for sandbox organizations to link them to their production counterpart.
|
|
402
|
+
*
|
|
403
|
+
*/
|
|
404
|
+
parent_production_org_id?: string | null;
|
|
405
|
+
/**
|
|
406
|
+
* Organization created date
|
|
407
|
+
*/
|
|
408
|
+
created_date?: string; // date-time
|
|
409
|
+
/**
|
|
410
|
+
* Organization logo URL
|
|
411
|
+
* example:
|
|
412
|
+
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
|
|
413
|
+
*/
|
|
414
|
+
logo_url?: string | null;
|
|
415
|
+
/**
|
|
416
|
+
* Organization logo thumbnail URL
|
|
417
|
+
* example:
|
|
418
|
+
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
|
|
419
|
+
*/
|
|
420
|
+
logo_thumbnail_url?: string | null;
|
|
421
|
+
/**
|
|
422
|
+
* Default email signature of organization
|
|
423
|
+
* example:
|
|
424
|
+
* <p>Thanks</p>
|
|
425
|
+
*/
|
|
426
|
+
signature?: string | null;
|
|
427
|
+
/**
|
|
428
|
+
* example:
|
|
429
|
+
* false
|
|
430
|
+
*/
|
|
431
|
+
is_unlicensed_org?: boolean | null;
|
|
432
|
+
/**
|
|
433
|
+
* Organization style setting (e.g. font setting)
|
|
434
|
+
*/
|
|
435
|
+
style?: {
|
|
436
|
+
[name: string]: any;
|
|
437
|
+
} | null;
|
|
438
|
+
type?: "Vendor" | "Partner";
|
|
439
|
+
/**
|
|
440
|
+
* example:
|
|
441
|
+
* EPI
|
|
442
|
+
*/
|
|
443
|
+
symbol?: string | null;
|
|
444
|
+
/**
|
|
445
|
+
* Deprecated - Please use pricing tier api
|
|
446
|
+
* example:
|
|
447
|
+
* professional
|
|
448
|
+
*/
|
|
449
|
+
pricing_tier?: string | null;
|
|
450
|
+
/**
|
|
451
|
+
* example:
|
|
452
|
+
* 50
|
|
453
|
+
*/
|
|
454
|
+
free_user_limit?: number | null;
|
|
455
|
+
/**
|
|
456
|
+
* Labels/tags associated with the organization for categorization and filtering.
|
|
457
|
+
* Used internally to classify organizations (e.g., "enterprise", "beta-tester", "test org").
|
|
458
|
+
*
|
|
459
|
+
*/
|
|
460
|
+
tags?: string[] | null;
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* Represents an epilot organization (tenant).
|
|
464
|
+
*
|
|
465
|
+
* An organization contains all the configuration, branding, and contact information
|
|
466
|
+
* for a tenant account on the epilot platform.
|
|
467
|
+
*
|
|
468
|
+
*/
|
|
469
|
+
export interface Organization {
|
|
470
|
+
id?: /**
|
|
471
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
472
|
+
* example:
|
|
473
|
+
* 739224
|
|
474
|
+
*/
|
|
475
|
+
OrganizationId;
|
|
476
|
+
/**
|
|
477
|
+
* Organization name
|
|
478
|
+
* example:
|
|
479
|
+
* Epilot
|
|
480
|
+
*/
|
|
481
|
+
name?: string | null;
|
|
482
|
+
/**
|
|
483
|
+
* Organization contact email
|
|
484
|
+
* example:
|
|
485
|
+
* someone@epilot.cloud
|
|
486
|
+
*/
|
|
487
|
+
email?: string | null;
|
|
488
|
+
/**
|
|
489
|
+
* Organization contact phone
|
|
490
|
+
* example:
|
|
491
|
+
* +49123123123
|
|
492
|
+
*/
|
|
493
|
+
phone?: string | null;
|
|
494
|
+
/**
|
|
495
|
+
* Organization website
|
|
496
|
+
* example:
|
|
497
|
+
* https://epilot.cloud
|
|
498
|
+
*/
|
|
499
|
+
website?: string | null;
|
|
500
|
+
/**
|
|
501
|
+
* Organization postal address
|
|
502
|
+
*/
|
|
503
|
+
address?: {
|
|
504
|
+
[name: string]: any;
|
|
505
|
+
country?: string | null;
|
|
506
|
+
city?: string | null;
|
|
507
|
+
postal_code?: string | null;
|
|
508
|
+
street?: string | null;
|
|
509
|
+
street_number?: string | null;
|
|
510
|
+
};
|
|
511
|
+
/**
|
|
512
|
+
* Indicates whether this is a production or sandbox organization.
|
|
513
|
+
* Sandbox organizations are linked to a parent production organization for testing purposes.
|
|
514
|
+
*
|
|
515
|
+
*/
|
|
516
|
+
organization_use?: "Production" | "Sandbox";
|
|
517
|
+
/**
|
|
518
|
+
* The ID of the parent production organization.
|
|
519
|
+
* Only set for sandbox organizations to link them to their production counterpart.
|
|
520
|
+
*
|
|
521
|
+
*/
|
|
522
|
+
parent_production_org_id?: string | null;
|
|
523
|
+
/**
|
|
524
|
+
* Organization created date
|
|
525
|
+
*/
|
|
526
|
+
created_date?: string; // date-time
|
|
527
|
+
/**
|
|
528
|
+
* Organization logo URL
|
|
529
|
+
* example:
|
|
530
|
+
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
|
|
531
|
+
*/
|
|
532
|
+
logo_url?: string | null;
|
|
533
|
+
/**
|
|
534
|
+
* Organization logo thumbnail URL
|
|
535
|
+
* example:
|
|
536
|
+
* https://epilot-playground-organization-data.s3.eu-central-1.amazonaws.com/epilot-logo.png
|
|
537
|
+
*/
|
|
538
|
+
logo_thumbnail_url?: string | null;
|
|
539
|
+
/**
|
|
540
|
+
* Default email signature of organization
|
|
541
|
+
* example:
|
|
542
|
+
* <p>Thanks</p>
|
|
543
|
+
*/
|
|
544
|
+
signature?: string | null;
|
|
545
|
+
/**
|
|
546
|
+
* example:
|
|
547
|
+
* false
|
|
548
|
+
*/
|
|
549
|
+
is_unlicensed_org?: boolean | null;
|
|
550
|
+
/**
|
|
551
|
+
* Organization style setting (e.g. font setting)
|
|
552
|
+
*/
|
|
553
|
+
style?: {
|
|
554
|
+
[name: string]: any;
|
|
555
|
+
} | null;
|
|
556
|
+
type?: "Vendor" | "Partner";
|
|
557
|
+
/**
|
|
558
|
+
* example:
|
|
559
|
+
* EPI
|
|
560
|
+
*/
|
|
561
|
+
symbol?: string | null;
|
|
562
|
+
/**
|
|
563
|
+
* Deprecated - Please use pricing tier api
|
|
564
|
+
* example:
|
|
565
|
+
* professional
|
|
566
|
+
*/
|
|
567
|
+
pricing_tier?: string | null;
|
|
568
|
+
/**
|
|
569
|
+
* example:
|
|
570
|
+
* 50
|
|
571
|
+
*/
|
|
572
|
+
free_user_limit?: number | null;
|
|
573
|
+
/**
|
|
574
|
+
* Labels/tags associated with the organization for categorization and filtering.
|
|
575
|
+
* Used internally to classify organizations (e.g., "enterprise", "beta-tester", "test org").
|
|
576
|
+
*
|
|
577
|
+
*/
|
|
578
|
+
tags?: string[] | null;
|
|
579
|
+
}
|
|
580
|
+
/**
|
|
581
|
+
* Records the cleanup status reported by a specific service for an organization.
|
|
582
|
+
* Each service that stores organization data reports its cleanup operations here.
|
|
583
|
+
*
|
|
584
|
+
*/
|
|
585
|
+
export interface OrganizationCleanupStatus {
|
|
586
|
+
org_id: /**
|
|
587
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
588
|
+
* example:
|
|
589
|
+
* 739224
|
|
590
|
+
*/
|
|
591
|
+
OrganizationId;
|
|
592
|
+
/**
|
|
593
|
+
* Name of the service reporting its cleanup status
|
|
594
|
+
* example:
|
|
595
|
+
* organization-api
|
|
596
|
+
*/
|
|
597
|
+
service_name: string;
|
|
598
|
+
/**
|
|
599
|
+
* List of cleanup operations performed by the service.
|
|
600
|
+
* Each operation describes what action was taken on which resource.
|
|
601
|
+
*
|
|
602
|
+
* example:
|
|
603
|
+
* [
|
|
604
|
+
* {
|
|
605
|
+
* "action": "Delete",
|
|
606
|
+
* "resource": "OrgTable",
|
|
607
|
+
* "extra_info": "pk: ORG#739224"
|
|
608
|
+
* },
|
|
609
|
+
* {
|
|
610
|
+
* "action": "Archive",
|
|
611
|
+
* "resource": "s3://my-bucket",
|
|
612
|
+
* "extra_info": "my-bucket/my-key.txt"
|
|
613
|
+
* }
|
|
614
|
+
* ]
|
|
615
|
+
*/
|
|
616
|
+
operations?: {
|
|
617
|
+
[name: string]: any;
|
|
618
|
+
/**
|
|
619
|
+
* The type of cleanup action performed.
|
|
620
|
+
* Common values: Delete, Archive, Purge
|
|
621
|
+
*
|
|
622
|
+
* example:
|
|
623
|
+
* Delete
|
|
624
|
+
*/
|
|
625
|
+
action?: string;
|
|
626
|
+
/**
|
|
627
|
+
* The resource that was cleaned up.
|
|
628
|
+
* Can be a table name, S3 bucket, or other resource identifier.
|
|
629
|
+
*
|
|
630
|
+
* example:
|
|
631
|
+
* OrgTable
|
|
632
|
+
*/
|
|
633
|
+
resource?: string;
|
|
634
|
+
/**
|
|
635
|
+
* Additional context about the cleanup operation
|
|
636
|
+
*/
|
|
637
|
+
extra_info?: /* Additional context about the cleanup operation */ string | number | boolean | {
|
|
638
|
+
[name: string]: any;
|
|
639
|
+
}[] | {
|
|
640
|
+
[name: string]: any;
|
|
641
|
+
};
|
|
642
|
+
}[];
|
|
643
|
+
}
|
|
644
|
+
/**
|
|
645
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
646
|
+
* example:
|
|
647
|
+
* 739224
|
|
648
|
+
*/
|
|
649
|
+
export type OrganizationId = string;
|
|
650
|
+
/**
|
|
651
|
+
* Represents an organization that has been marked for deletion and requires cleanup.
|
|
652
|
+
* Contains metadata about the deletion request.
|
|
653
|
+
*
|
|
654
|
+
*/
|
|
655
|
+
export interface OrganizationToCleanup {
|
|
656
|
+
org_id: /**
|
|
657
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
658
|
+
* example:
|
|
659
|
+
* 739224
|
|
660
|
+
*/
|
|
661
|
+
OrganizationId;
|
|
662
|
+
/**
|
|
663
|
+
* Timestamp when the organization was marked for deletion
|
|
664
|
+
* example:
|
|
665
|
+
* 2021-06-01T00:00:00Z
|
|
666
|
+
*/
|
|
667
|
+
deleted_at: string; // date-time
|
|
668
|
+
/**
|
|
669
|
+
* User ID of the person who initiated the deletion
|
|
670
|
+
* example:
|
|
671
|
+
* 123456
|
|
672
|
+
*/
|
|
673
|
+
deleted_by: string;
|
|
674
|
+
}
|
|
675
|
+
/**
|
|
676
|
+
* A unique key identifying an organization setting.
|
|
677
|
+
* Common setting keys include: double_opt_in, email_tracking, default_language, workflow_notifications
|
|
678
|
+
*
|
|
679
|
+
* example:
|
|
680
|
+
* double_opt_in
|
|
681
|
+
*/
|
|
682
|
+
export type SettingKey = string;
|
|
683
|
+
/**
|
|
684
|
+
* A key-value map of all organization settings.
|
|
685
|
+
* Keys are setting identifiers and values can be any valid JSON type.
|
|
686
|
+
*
|
|
687
|
+
* example:
|
|
688
|
+
* {
|
|
689
|
+
* "double_opt_in": {
|
|
690
|
+
* "enabled": true
|
|
691
|
+
* },
|
|
692
|
+
* "email_tracking": {
|
|
693
|
+
* "enabled": true,
|
|
694
|
+
* "track_opens": true
|
|
695
|
+
* },
|
|
696
|
+
* "default_language": "de"
|
|
697
|
+
* }
|
|
698
|
+
*/
|
|
699
|
+
export interface Settings {
|
|
700
|
+
[name: string]: any;
|
|
701
|
+
}
|
|
702
|
+
/**
|
|
703
|
+
* The value of an organization setting.
|
|
704
|
+
* Can be any valid JSON type: string, number, boolean, array, or object.
|
|
705
|
+
*
|
|
706
|
+
* example:
|
|
707
|
+
* {
|
|
708
|
+
* "enabled": true
|
|
709
|
+
* }
|
|
710
|
+
*/
|
|
711
|
+
export type SettingsValue = /**
|
|
712
|
+
* The value of an organization setting.
|
|
713
|
+
* Can be any valid JSON type: string, number, boolean, array, or object.
|
|
714
|
+
*
|
|
715
|
+
* example:
|
|
716
|
+
* {
|
|
717
|
+
* "enabled": true
|
|
718
|
+
* }
|
|
719
|
+
*/
|
|
720
|
+
string | number | boolean | {
|
|
721
|
+
[name: string]: any;
|
|
722
|
+
}[] | {
|
|
723
|
+
[name: string]: any;
|
|
724
|
+
};
|
|
725
|
+
/**
|
|
726
|
+
* A rule that determines feature visibility. Rules are combined with AND logic
|
|
727
|
+
* at the top level. Supports boolean combinators (and, or, not) for complex logic.
|
|
728
|
+
*
|
|
729
|
+
*/
|
|
730
|
+
export interface VisibilityRule {
|
|
731
|
+
/**
|
|
732
|
+
* The rule type discriminator
|
|
733
|
+
*/
|
|
734
|
+
type: "always" | "never" | "advanced_mode" | "pricing_tier" | "feature_flag" | "permission" | "setting_enabled" | "flag_enabled" | "not" | "and" | "or";
|
|
735
|
+
/**
|
|
736
|
+
* Setting key for pricing_tier and setting_enabled rules
|
|
737
|
+
*/
|
|
738
|
+
setting_key?: string;
|
|
739
|
+
/**
|
|
740
|
+
* Flag name for feature_flag and flag_enabled rules
|
|
741
|
+
*/
|
|
742
|
+
flag_name?: string;
|
|
743
|
+
/**
|
|
744
|
+
* Permission action for permission rules
|
|
745
|
+
*/
|
|
746
|
+
action?: string;
|
|
747
|
+
/**
|
|
748
|
+
* Optional resource for permission rules
|
|
749
|
+
*/
|
|
750
|
+
resource?: string;
|
|
751
|
+
rule?: /**
|
|
752
|
+
* A rule that determines feature visibility. Rules are combined with AND logic
|
|
753
|
+
* at the top level. Supports boolean combinators (and, or, not) for complex logic.
|
|
754
|
+
*
|
|
755
|
+
*/
|
|
756
|
+
VisibilityRule;
|
|
757
|
+
/**
|
|
758
|
+
* Child rules for and/or combinators
|
|
759
|
+
*/
|
|
760
|
+
rules?: /**
|
|
761
|
+
* A rule that determines feature visibility. Rules are combined with AND logic
|
|
762
|
+
* at the top level. Supports boolean combinators (and, or, not) for complex logic.
|
|
763
|
+
*
|
|
764
|
+
*/
|
|
765
|
+
VisibilityRule[];
|
|
766
|
+
}
|
|
767
|
+
}
|
|
768
|
+
}
|
|
769
|
+
declare namespace Paths {
|
|
770
|
+
namespace DeleteSettingsValue {
|
|
771
|
+
namespace Parameters {
|
|
772
|
+
export type Key = string;
|
|
773
|
+
export type OrgId = /**
|
|
774
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
775
|
+
* example:
|
|
776
|
+
* 739224
|
|
777
|
+
*/
|
|
778
|
+
Components.Schemas.OrganizationId;
|
|
779
|
+
}
|
|
780
|
+
export interface PathParameters {
|
|
781
|
+
org_id: Parameters.OrgId;
|
|
782
|
+
key: Parameters.Key;
|
|
783
|
+
}
|
|
784
|
+
namespace Responses {
|
|
785
|
+
export interface $200 {
|
|
786
|
+
}
|
|
787
|
+
export interface $401 {
|
|
788
|
+
}
|
|
789
|
+
export interface $403 {
|
|
790
|
+
}
|
|
791
|
+
export interface $404 {
|
|
792
|
+
}
|
|
793
|
+
}
|
|
794
|
+
}
|
|
795
|
+
namespace GetCurrentOrganization {
|
|
796
|
+
namespace Responses {
|
|
797
|
+
export type $200 = /**
|
|
798
|
+
* Represents an epilot organization (tenant).
|
|
799
|
+
*
|
|
800
|
+
* An organization contains all the configuration, branding, and contact information
|
|
801
|
+
* for a tenant account on the epilot platform.
|
|
802
|
+
*
|
|
803
|
+
*/
|
|
804
|
+
Components.Schemas.Organization;
|
|
805
|
+
export interface $401 {
|
|
806
|
+
}
|
|
807
|
+
export interface $403 {
|
|
808
|
+
}
|
|
809
|
+
}
|
|
810
|
+
}
|
|
811
|
+
namespace GetFeatureSettings {
|
|
812
|
+
namespace Responses {
|
|
813
|
+
export type $200 = /* Feature settings metadata served to frontend applications. */ Components.Schemas.FeatureSettings;
|
|
814
|
+
export interface $401 {
|
|
815
|
+
}
|
|
816
|
+
}
|
|
817
|
+
}
|
|
818
|
+
namespace GetOrganization {
|
|
819
|
+
namespace Parameters {
|
|
820
|
+
export type OrgId = /**
|
|
821
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
822
|
+
* example:
|
|
823
|
+
* 739224
|
|
824
|
+
*/
|
|
825
|
+
Components.Schemas.OrganizationId;
|
|
826
|
+
}
|
|
827
|
+
export interface PathParameters {
|
|
828
|
+
org_id: Parameters.OrgId;
|
|
829
|
+
}
|
|
830
|
+
namespace Responses {
|
|
831
|
+
export type $200 = /**
|
|
832
|
+
* Represents an epilot organization (tenant).
|
|
833
|
+
*
|
|
834
|
+
* An organization contains all the configuration, branding, and contact information
|
|
835
|
+
* for a tenant account on the epilot platform.
|
|
836
|
+
*
|
|
837
|
+
*/
|
|
838
|
+
Components.Schemas.Organization;
|
|
839
|
+
export interface $401 {
|
|
840
|
+
}
|
|
841
|
+
export interface $403 {
|
|
842
|
+
}
|
|
843
|
+
export interface $404 {
|
|
844
|
+
}
|
|
845
|
+
}
|
|
846
|
+
}
|
|
847
|
+
namespace GetSettings {
|
|
848
|
+
namespace Parameters {
|
|
849
|
+
export type OrgId = /**
|
|
850
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
851
|
+
* example:
|
|
852
|
+
* 739224
|
|
853
|
+
*/
|
|
854
|
+
Components.Schemas.OrganizationId;
|
|
855
|
+
}
|
|
856
|
+
export interface PathParameters {
|
|
857
|
+
org_id: Parameters.OrgId;
|
|
858
|
+
}
|
|
859
|
+
namespace Responses {
|
|
860
|
+
export type $200 = /**
|
|
861
|
+
* A key-value map of all organization settings.
|
|
862
|
+
* Keys are setting identifiers and values can be any valid JSON type.
|
|
863
|
+
*
|
|
864
|
+
* example:
|
|
865
|
+
* {
|
|
866
|
+
* "double_opt_in": {
|
|
867
|
+
* "enabled": true
|
|
868
|
+
* },
|
|
869
|
+
* "email_tracking": {
|
|
870
|
+
* "enabled": true,
|
|
871
|
+
* "track_opens": true
|
|
872
|
+
* },
|
|
873
|
+
* "default_language": "de"
|
|
874
|
+
* }
|
|
875
|
+
*/
|
|
876
|
+
Components.Schemas.Settings;
|
|
877
|
+
export interface $401 {
|
|
878
|
+
}
|
|
879
|
+
export interface $403 {
|
|
880
|
+
}
|
|
881
|
+
export interface $404 {
|
|
882
|
+
}
|
|
883
|
+
}
|
|
884
|
+
}
|
|
885
|
+
namespace PutSettingsValue {
|
|
886
|
+
namespace Parameters {
|
|
887
|
+
export type Key = string;
|
|
888
|
+
export type OrgId = /**
|
|
889
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
890
|
+
* example:
|
|
891
|
+
* 739224
|
|
892
|
+
*/
|
|
893
|
+
Components.Schemas.OrganizationId;
|
|
894
|
+
}
|
|
895
|
+
export interface PathParameters {
|
|
896
|
+
org_id: Parameters.OrgId;
|
|
897
|
+
key: Parameters.Key;
|
|
898
|
+
}
|
|
899
|
+
export type RequestBody = /**
|
|
900
|
+
* The value of an organization setting.
|
|
901
|
+
* Can be any valid JSON type: string, number, boolean, array, or object.
|
|
902
|
+
*
|
|
903
|
+
* example:
|
|
904
|
+
* {
|
|
905
|
+
* "enabled": true
|
|
906
|
+
* }
|
|
907
|
+
*/
|
|
908
|
+
Components.Schemas.SettingsValue;
|
|
909
|
+
namespace Responses {
|
|
910
|
+
export type $200 = /**
|
|
911
|
+
* The value of an organization setting.
|
|
912
|
+
* Can be any valid JSON type: string, number, boolean, array, or object.
|
|
913
|
+
*
|
|
914
|
+
* example:
|
|
915
|
+
* {
|
|
916
|
+
* "enabled": true
|
|
917
|
+
* }
|
|
918
|
+
*/
|
|
919
|
+
Components.Schemas.SettingsValue;
|
|
920
|
+
export interface $400 {
|
|
921
|
+
}
|
|
922
|
+
export interface $401 {
|
|
923
|
+
}
|
|
924
|
+
export interface $403 {
|
|
925
|
+
}
|
|
926
|
+
export interface $404 {
|
|
927
|
+
}
|
|
928
|
+
}
|
|
929
|
+
}
|
|
930
|
+
namespace UpdateOrganization {
|
|
931
|
+
namespace Parameters {
|
|
932
|
+
export type OrgId = /**
|
|
933
|
+
* Unique identifier for an organization (tenant) in the epilot platform
|
|
934
|
+
* example:
|
|
935
|
+
* 739224
|
|
936
|
+
*/
|
|
937
|
+
Components.Schemas.OrganizationId;
|
|
938
|
+
}
|
|
939
|
+
export interface PathParameters {
|
|
940
|
+
org_id: Parameters.OrgId;
|
|
941
|
+
}
|
|
942
|
+
export type RequestBody = /**
|
|
943
|
+
* Represents an epilot organization (tenant).
|
|
944
|
+
*
|
|
945
|
+
* An organization contains all the configuration, branding, and contact information
|
|
946
|
+
* for a tenant account on the epilot platform.
|
|
947
|
+
*
|
|
948
|
+
*/
|
|
949
|
+
Components.Schemas.Organization;
|
|
950
|
+
namespace Responses {
|
|
951
|
+
export type $200 = /**
|
|
952
|
+
* Represents an epilot organization (tenant).
|
|
953
|
+
*
|
|
954
|
+
* An organization contains all the configuration, branding, and contact information
|
|
955
|
+
* for a tenant account on the epilot platform.
|
|
956
|
+
*
|
|
957
|
+
*/
|
|
958
|
+
Components.Schemas.Organization;
|
|
959
|
+
export interface $400 {
|
|
960
|
+
}
|
|
961
|
+
export interface $401 {
|
|
962
|
+
}
|
|
963
|
+
export interface $403 {
|
|
964
|
+
}
|
|
965
|
+
export interface $404 {
|
|
966
|
+
}
|
|
967
|
+
}
|
|
968
|
+
}
|
|
969
|
+
}
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
interface OperationMethods {
|
|
973
|
+
/**
|
|
974
|
+
* getCurrentOrganization - getCurrentOrganization
|
|
975
|
+
*
|
|
976
|
+
* Retrieves the organization associated with the authenticated user's current session.
|
|
977
|
+
*
|
|
978
|
+
* This endpoint is useful for fetching organization details without knowing the organization ID,
|
|
979
|
+
* as it automatically resolves the organization from the authentication token.
|
|
980
|
+
*
|
|
981
|
+
*/
|
|
982
|
+
'getCurrentOrganization'(
|
|
983
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
984
|
+
data?: any,
|
|
985
|
+
config?: AxiosRequestConfig
|
|
986
|
+
): OperationResponse<Paths.GetCurrentOrganization.Responses.$200>
|
|
987
|
+
/**
|
|
988
|
+
* getOrganization - getOrganization
|
|
989
|
+
*
|
|
990
|
+
* Retrieves detailed information about a specific organization by its unique identifier.
|
|
991
|
+
*
|
|
992
|
+
* Returns the organization's profile information including name, contact details,
|
|
993
|
+
* address, branding assets, and configuration.
|
|
994
|
+
*
|
|
995
|
+
*/
|
|
996
|
+
'getOrganization'(
|
|
997
|
+
parameters?: Parameters<Paths.GetOrganization.PathParameters> | null,
|
|
998
|
+
data?: any,
|
|
999
|
+
config?: AxiosRequestConfig
|
|
1000
|
+
): OperationResponse<Paths.GetOrganization.Responses.$200>
|
|
1001
|
+
/**
|
|
1002
|
+
* updateOrganization - updateOrganization
|
|
1003
|
+
*
|
|
1004
|
+
* Updates an organization's profile information.
|
|
1005
|
+
*
|
|
1006
|
+
* This endpoint supports partial updates - only the fields provided in the request body
|
|
1007
|
+
* will be modified. Fields not included in the request will retain their current values.
|
|
1008
|
+
*
|
|
1009
|
+
* Common use cases:
|
|
1010
|
+
* - Updating contact information (email, phone, website)
|
|
1011
|
+
* - Changing the organization name
|
|
1012
|
+
* - Updating the postal address
|
|
1013
|
+
* - Setting or updating branding assets (logo_url, logo_thumbnail_url)
|
|
1014
|
+
* - Configuring the default email signature
|
|
1015
|
+
*
|
|
1016
|
+
*/
|
|
1017
|
+
'updateOrganization'(
|
|
1018
|
+
parameters?: Parameters<Paths.UpdateOrganization.PathParameters> | null,
|
|
1019
|
+
data?: Paths.UpdateOrganization.RequestBody,
|
|
1020
|
+
config?: AxiosRequestConfig
|
|
1021
|
+
): OperationResponse<Paths.UpdateOrganization.Responses.$200>
|
|
1022
|
+
/**
|
|
1023
|
+
* getSettings - getSettings
|
|
1024
|
+
*
|
|
1025
|
+
* Retrieves all configuration settings for an organization.
|
|
1026
|
+
*
|
|
1027
|
+
* Returns a key-value map of all settings configured for the organization.
|
|
1028
|
+
* Settings control various platform features and behaviors including:
|
|
1029
|
+
* - Feature flags (e.g., double_opt_in, email_tracking)
|
|
1030
|
+
* - Integration configurations
|
|
1031
|
+
* - UI preferences
|
|
1032
|
+
* - Workflow settings
|
|
1033
|
+
*
|
|
1034
|
+
*/
|
|
1035
|
+
'getSettings'(
|
|
1036
|
+
parameters?: Parameters<Paths.GetSettings.PathParameters> | null,
|
|
1037
|
+
data?: any,
|
|
1038
|
+
config?: AxiosRequestConfig
|
|
1039
|
+
): OperationResponse<Paths.GetSettings.Responses.$200>
|
|
1040
|
+
/**
|
|
1041
|
+
* putSettingsValue - putSettingsValue
|
|
1042
|
+
*
|
|
1043
|
+
* Creates or updates a specific organization setting identified by its key.
|
|
1044
|
+
*
|
|
1045
|
+
* The setting value can be any valid JSON type:
|
|
1046
|
+
* - String (e.g., "en", "production")
|
|
1047
|
+
* - Number (e.g., 100, 3.14)
|
|
1048
|
+
* - Boolean (e.g., true, false)
|
|
1049
|
+
* - Object (e.g., {"enabled": true, "threshold": 50})
|
|
1050
|
+
* - Array (e.g., ["email", "sms", "push"])
|
|
1051
|
+
*
|
|
1052
|
+
* If the setting key does not exist, it will be created. If it exists, its value
|
|
1053
|
+
* will be replaced with the new value.
|
|
1054
|
+
*
|
|
1055
|
+
*/
|
|
1056
|
+
'putSettingsValue'(
|
|
1057
|
+
parameters?: Parameters<Paths.PutSettingsValue.PathParameters> | null,
|
|
1058
|
+
data?: Paths.PutSettingsValue.RequestBody,
|
|
1059
|
+
config?: AxiosRequestConfig
|
|
1060
|
+
): OperationResponse<Paths.PutSettingsValue.Responses.$200>
|
|
1061
|
+
/**
|
|
1062
|
+
* deleteSettingsValue - deleteSettingsValue
|
|
1063
|
+
*
|
|
1064
|
+
* Removes a specific organization setting identified by its key.
|
|
1065
|
+
*
|
|
1066
|
+
* After deletion, the setting will no longer appear in the organization's settings
|
|
1067
|
+
* and any features relying on this setting will use their default behavior.
|
|
1068
|
+
*
|
|
1069
|
+
*/
|
|
1070
|
+
'deleteSettingsValue'(
|
|
1071
|
+
parameters?: Parameters<Paths.DeleteSettingsValue.PathParameters> | null,
|
|
1072
|
+
data?: any,
|
|
1073
|
+
config?: AxiosRequestConfig
|
|
1074
|
+
): OperationResponse<Paths.DeleteSettingsValue.Responses.$200>
|
|
1075
|
+
/**
|
|
1076
|
+
* getFeatureSettings - Get platform configuration metadata
|
|
1077
|
+
*
|
|
1078
|
+
* Returns platform-level configuration metadata including feature flag definitions,
|
|
1079
|
+
* resource type mappings, and error code severities.
|
|
1080
|
+
*
|
|
1081
|
+
* This data is static (identical for all organizations) and changes infrequently.
|
|
1082
|
+
* Clients should cache responses using the Cache-Control header.
|
|
1083
|
+
*
|
|
1084
|
+
*/
|
|
1085
|
+
'getFeatureSettings'(
|
|
1086
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1087
|
+
data?: any,
|
|
1088
|
+
config?: AxiosRequestConfig
|
|
1089
|
+
): OperationResponse<Paths.GetFeatureSettings.Responses.$200>
|
|
1090
|
+
}
|
|
1091
|
+
|
|
1092
|
+
interface PathsDictionary {
|
|
1093
|
+
['/v2/organization/current']: {
|
|
1094
|
+
/**
|
|
1095
|
+
* getCurrentOrganization - getCurrentOrganization
|
|
1096
|
+
*
|
|
1097
|
+
* Retrieves the organization associated with the authenticated user's current session.
|
|
1098
|
+
*
|
|
1099
|
+
* This endpoint is useful for fetching organization details without knowing the organization ID,
|
|
1100
|
+
* as it automatically resolves the organization from the authentication token.
|
|
1101
|
+
*
|
|
1102
|
+
*/
|
|
1103
|
+
'get'(
|
|
1104
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1105
|
+
data?: any,
|
|
1106
|
+
config?: AxiosRequestConfig
|
|
1107
|
+
): OperationResponse<Paths.GetCurrentOrganization.Responses.$200>
|
|
1108
|
+
}
|
|
1109
|
+
['/v2/organization/{org_id}']: {
|
|
1110
|
+
/**
|
|
1111
|
+
* getOrganization - getOrganization
|
|
1112
|
+
*
|
|
1113
|
+
* Retrieves detailed information about a specific organization by its unique identifier.
|
|
1114
|
+
*
|
|
1115
|
+
* Returns the organization's profile information including name, contact details,
|
|
1116
|
+
* address, branding assets, and configuration.
|
|
1117
|
+
*
|
|
1118
|
+
*/
|
|
1119
|
+
'get'(
|
|
1120
|
+
parameters?: Parameters<Paths.GetOrganization.PathParameters> | null,
|
|
1121
|
+
data?: any,
|
|
1122
|
+
config?: AxiosRequestConfig
|
|
1123
|
+
): OperationResponse<Paths.GetOrganization.Responses.$200>
|
|
1124
|
+
/**
|
|
1125
|
+
* updateOrganization - updateOrganization
|
|
1126
|
+
*
|
|
1127
|
+
* Updates an organization's profile information.
|
|
1128
|
+
*
|
|
1129
|
+
* This endpoint supports partial updates - only the fields provided in the request body
|
|
1130
|
+
* will be modified. Fields not included in the request will retain their current values.
|
|
1131
|
+
*
|
|
1132
|
+
* Common use cases:
|
|
1133
|
+
* - Updating contact information (email, phone, website)
|
|
1134
|
+
* - Changing the organization name
|
|
1135
|
+
* - Updating the postal address
|
|
1136
|
+
* - Setting or updating branding assets (logo_url, logo_thumbnail_url)
|
|
1137
|
+
* - Configuring the default email signature
|
|
1138
|
+
*
|
|
1139
|
+
*/
|
|
1140
|
+
'patch'(
|
|
1141
|
+
parameters?: Parameters<Paths.UpdateOrganization.PathParameters> | null,
|
|
1142
|
+
data?: Paths.UpdateOrganization.RequestBody,
|
|
1143
|
+
config?: AxiosRequestConfig
|
|
1144
|
+
): OperationResponse<Paths.UpdateOrganization.Responses.$200>
|
|
1145
|
+
}
|
|
1146
|
+
['/v2/organization/{org_id}/settings']: {
|
|
1147
|
+
/**
|
|
1148
|
+
* getSettings - getSettings
|
|
1149
|
+
*
|
|
1150
|
+
* Retrieves all configuration settings for an organization.
|
|
1151
|
+
*
|
|
1152
|
+
* Returns a key-value map of all settings configured for the organization.
|
|
1153
|
+
* Settings control various platform features and behaviors including:
|
|
1154
|
+
* - Feature flags (e.g., double_opt_in, email_tracking)
|
|
1155
|
+
* - Integration configurations
|
|
1156
|
+
* - UI preferences
|
|
1157
|
+
* - Workflow settings
|
|
1158
|
+
*
|
|
1159
|
+
*/
|
|
1160
|
+
'get'(
|
|
1161
|
+
parameters?: Parameters<Paths.GetSettings.PathParameters> | null,
|
|
1162
|
+
data?: any,
|
|
1163
|
+
config?: AxiosRequestConfig
|
|
1164
|
+
): OperationResponse<Paths.GetSettings.Responses.$200>
|
|
1165
|
+
}
|
|
1166
|
+
['/v2/organization/{org_id}/settings/{key}']: {
|
|
1167
|
+
/**
|
|
1168
|
+
* putSettingsValue - putSettingsValue
|
|
1169
|
+
*
|
|
1170
|
+
* Creates or updates a specific organization setting identified by its key.
|
|
1171
|
+
*
|
|
1172
|
+
* The setting value can be any valid JSON type:
|
|
1173
|
+
* - String (e.g., "en", "production")
|
|
1174
|
+
* - Number (e.g., 100, 3.14)
|
|
1175
|
+
* - Boolean (e.g., true, false)
|
|
1176
|
+
* - Object (e.g., {"enabled": true, "threshold": 50})
|
|
1177
|
+
* - Array (e.g., ["email", "sms", "push"])
|
|
1178
|
+
*
|
|
1179
|
+
* If the setting key does not exist, it will be created. If it exists, its value
|
|
1180
|
+
* will be replaced with the new value.
|
|
1181
|
+
*
|
|
1182
|
+
*/
|
|
1183
|
+
'put'(
|
|
1184
|
+
parameters?: Parameters<Paths.PutSettingsValue.PathParameters> | null,
|
|
1185
|
+
data?: Paths.PutSettingsValue.RequestBody,
|
|
1186
|
+
config?: AxiosRequestConfig
|
|
1187
|
+
): OperationResponse<Paths.PutSettingsValue.Responses.$200>
|
|
1188
|
+
/**
|
|
1189
|
+
* deleteSettingsValue - deleteSettingsValue
|
|
1190
|
+
*
|
|
1191
|
+
* Removes a specific organization setting identified by its key.
|
|
1192
|
+
*
|
|
1193
|
+
* After deletion, the setting will no longer appear in the organization's settings
|
|
1194
|
+
* and any features relying on this setting will use their default behavior.
|
|
1195
|
+
*
|
|
1196
|
+
*/
|
|
1197
|
+
'delete'(
|
|
1198
|
+
parameters?: Parameters<Paths.DeleteSettingsValue.PathParameters> | null,
|
|
1199
|
+
data?: any,
|
|
1200
|
+
config?: AxiosRequestConfig
|
|
1201
|
+
): OperationResponse<Paths.DeleteSettingsValue.Responses.$200>
|
|
1202
|
+
}
|
|
1203
|
+
['/v2/feature-settings']: {
|
|
1204
|
+
/**
|
|
1205
|
+
* getFeatureSettings - Get platform configuration metadata
|
|
1206
|
+
*
|
|
1207
|
+
* Returns platform-level configuration metadata including feature flag definitions,
|
|
1208
|
+
* resource type mappings, and error code severities.
|
|
1209
|
+
*
|
|
1210
|
+
* This data is static (identical for all organizations) and changes infrequently.
|
|
1211
|
+
* Clients should cache responses using the Cache-Control header.
|
|
1212
|
+
*
|
|
1213
|
+
*/
|
|
1214
|
+
'get'(
|
|
1215
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
1216
|
+
data?: any,
|
|
1217
|
+
config?: AxiosRequestConfig
|
|
1218
|
+
): OperationResponse<Paths.GetFeatureSettings.Responses.$200>
|
|
1219
|
+
}
|
|
1220
|
+
}
|
|
1221
|
+
|
|
1222
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
type CreateOrganizationRequest = Components.Schemas.CreateOrganizationRequest;
|
|
1226
|
+
type DataPoint = Components.Schemas.DataPoint;
|
|
1227
|
+
type DataPointsResponse = Components.Schemas.DataPointsResponse;
|
|
1228
|
+
type FeatureFlagMetadata = Components.Schemas.FeatureFlagMetadata;
|
|
1229
|
+
type FeatureSettings = Components.Schemas.FeatureSettings;
|
|
1230
|
+
type HubspotCompaniesResponse = Components.Schemas.HubspotCompaniesResponse;
|
|
1231
|
+
type HubspotCompany = Components.Schemas.HubspotCompany;
|
|
1232
|
+
type HubspotOrganizationData = Components.Schemas.HubspotOrganizationData;
|
|
1233
|
+
type I18nString = Components.Schemas.I18nString;
|
|
1234
|
+
type InternalOrganization = Components.Schemas.InternalOrganization;
|
|
1235
|
+
type Organization = Components.Schemas.Organization;
|
|
1236
|
+
type OrganizationCleanupStatus = Components.Schemas.OrganizationCleanupStatus;
|
|
1237
|
+
type OrganizationId = Components.Schemas.OrganizationId;
|
|
1238
|
+
type OrganizationToCleanup = Components.Schemas.OrganizationToCleanup;
|
|
1239
|
+
type SettingKey = Components.Schemas.SettingKey;
|
|
1240
|
+
type Settings = Components.Schemas.Settings;
|
|
1241
|
+
type SettingsValue = Components.Schemas.SettingsValue;
|
|
1242
|
+
type VisibilityRule = Components.Schemas.VisibilityRule;
|
|
1243
|
+
|
|
1244
|
+
export { type Client as C, type DataPoint as D, type FeatureFlagMetadata as F, type HubspotCompaniesResponse as H, type I18nString as I, type OperationMethods as O, Paths as P, type SettingKey as S, type VisibilityRule as V, Components as a, type PathsDictionary as b, type CreateOrganizationRequest as c, type DataPointsResponse as d, type FeatureSettings as e, type HubspotCompany as f, type HubspotOrganizationData as g, type InternalOrganization as h, type Organization as i, type OrganizationCleanupStatus as j, type OrganizationId as k, type OrganizationToCleanup as l, type Settings as m, type SettingsValue as n };
|