@epilot/sdk 2.15.0 → 2.15.2
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-runtime.json +1 -1
- package/definitions/app.json +458 -3
- package/definitions/email-settings-runtime.json +1 -1
- package/definitions/email-settings.json +853 -16
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +8 -8
- package/dist/apis/app.d.cts +2 -2
- package/dist/apis/app.d.ts +2 -2
- package/dist/apis/app.js +2 -2
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +8 -8
- package/dist/apis/email-settings.d.cts +2 -2
- package/dist/apis/email-settings.d.ts +2 -2
- package/dist/apis/email-settings.js +2 -2
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/app-2PHMS5XK.js +7 -0
- package/dist/app-J4RJL6KV.cjs +7 -0
- package/dist/app-runtime-2QBLB4AK.cjs +5 -0
- package/dist/{app-runtime-DBUXZL6E.js → app-runtime-6T473MHJ.js} +1 -1
- package/dist/{app.d-BOR23dso.d.cts → app.d-E1es05Ga.d.cts} +380 -4
- package/dist/{app.d-BOR23dso.d.ts → app.d-E1es05Ga.d.ts} +380 -4
- package/dist/chunk-KHKNOPEX.js +14 -0
- package/dist/{chunk-GB3RZYS2.js → chunk-LNQHT4WZ.js} +4 -4
- package/dist/{chunk-KMVJYNLB.cjs → chunk-W6BCTQLU.cjs} +1 -1
- package/dist/chunk-YNJPE3SS.cjs +14 -0
- package/dist/{chunk-C4HXUTOU.cjs → chunk-YYWUKE4L.cjs} +4 -4
- package/dist/{chunk-Z4H2FZ2K.js → chunk-ZEOU24C3.js} +1 -1
- package/dist/email-settings-ECSU7KWC.js +7 -0
- package/dist/email-settings-RHMYC2KT.cjs +7 -0
- package/dist/{email-settings-runtime-BXRZV4M5.js → email-settings-runtime-4BT72ADN.js} +1 -1
- package/dist/{email-settings-runtime-FWJQBQBK.cjs → email-settings-runtime-J7JLYDMU.cjs} +2 -2
- package/dist/{email-settings.d-UJ0C3jPI.d.ts → email-settings.d-CR4lORuR.d.cts} +721 -2
- package/dist/{email-settings.d-UJ0C3jPI.d.cts → email-settings.d-CR4lORuR.d.ts} +721 -2
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/dist/js-yaml-DLCVPJ7G.js +0 -0
- package/docs/app.md +215 -10
- package/docs/email-settings.md +584 -1
- package/package.json +11 -12
- package/definitions/focus-pocus-runtime.json +0 -1
- package/definitions/focus-pocus.json +0 -757
- package/dist/app-74LECFMK.cjs +0 -7
- package/dist/app-GNUHCGPO.js +0 -7
- package/dist/app-runtime-AFNM67YN.cjs +0 -5
- package/dist/chunk-KCPVNRDL.js +0 -14
- package/dist/chunk-YI5YGTAH.cjs +0 -14
- package/dist/email-settings-YJ4X5VFU.cjs +0 -7
- package/dist/email-settings-YUK3DXFJ.js +0 -7
|
@@ -148,9 +148,9 @@ declare namespace Components {
|
|
|
148
148
|
*/
|
|
149
149
|
name: string; // ^[a-zA-Z0-9_-]+$
|
|
150
150
|
/**
|
|
151
|
-
* Base URL of the target API. Must be HTTPS.
|
|
151
|
+
* Base URL of the target API. Must be HTTPS. May reference component options via {{option_key}} interpolation (resolved from decrypted values), e.g. "https://{{cluster}}.example.com/api" for a per-installation host. The fully-resolved URL is validated at request time (SSRF protection).
|
|
152
152
|
*/
|
|
153
|
-
target: string; //
|
|
153
|
+
target: string; // ^https://
|
|
154
154
|
/**
|
|
155
155
|
* Authentication strategy
|
|
156
156
|
*/
|
|
@@ -163,6 +163,12 @@ declare namespace Components {
|
|
|
163
163
|
* OAuth2 token endpoint URL
|
|
164
164
|
*/
|
|
165
165
|
token_url?: string; // uri ^https://
|
|
166
|
+
/**
|
|
167
|
+
* Additional request headers injected server-side on every proxied request. Values may reference component options via {{option_key}} interpolation (resolved from decrypted secrets), so credentials are never exposed to the client. Applied in addition to auth_type.
|
|
168
|
+
*/
|
|
169
|
+
headers?: {
|
|
170
|
+
[name: string]: string;
|
|
171
|
+
};
|
|
166
172
|
}
|
|
167
173
|
export interface AppBridgeSurfaceConfig {
|
|
168
174
|
/**
|
|
@@ -1592,7 +1598,38 @@ declare namespace Components {
|
|
|
1592
1598
|
* The portal looks up this hook implicitly per extension (one `visualizationMetadata` hook per extension) — there is no need for a data-retrieval hook to reference it explicitly.
|
|
1593
1599
|
*
|
|
1594
1600
|
*/
|
|
1595
|
-
PortalExtensionHookVisualizationMetadata
|
|
1601
|
+
PortalExtensionHookVisualizationMetadata | /**
|
|
1602
|
+
* Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not run its own change email flow. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change.
|
|
1603
|
+
* The `change_mode` controls what the portal does after the call:
|
|
1604
|
+
* - `asynchronous`: The third-party system takes the email change over entirely (most likely by sending the user instructions to confirm the new email address). The portal does not change the login email itself.
|
|
1605
|
+
* - `synchronous`: The third-party system applies the email change immediately. The portal waits for a successful (2xx) response and then also changes the portal user's login email right away, without sending a confirmation email. The user has to sign in again with the new email address afterwards.
|
|
1606
|
+
*
|
|
1607
|
+
* The expected response http status code to the call is:
|
|
1608
|
+
* - 2xx if the request was accepted
|
|
1609
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
1610
|
+
*
|
|
1611
|
+
*/
|
|
1612
|
+
PortalExtensionHookChangeEmail | /**
|
|
1613
|
+
* Hook that replaces the built-in change password functionality for portal users. When configured, the portal does not change the user's password itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the password change (most likely by sending the user instructions to complete the process).
|
|
1614
|
+
* The expected response http status code to the call is:
|
|
1615
|
+
* - 2xx if the request was accepted
|
|
1616
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
1617
|
+
*
|
|
1618
|
+
*/
|
|
1619
|
+
PortalExtensionHookChangePassword | /**
|
|
1620
|
+
* Hook that replaces the built-in delete account functionality for portal users. When configured, the portal does not delete the user itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the deletion.
|
|
1621
|
+
* The `deletion_mode` controls what the portal does after the call:
|
|
1622
|
+
* - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the corresponding epilot Cognito user.
|
|
1623
|
+
* - `asynchronous`: The third-party system handles deletion out-of-band. The portal does not delete anything immediately; cleanup is expected to happen later (e.g. via the user deletion API or webhooks).
|
|
1624
|
+
*
|
|
1625
|
+
* The optional `delete_contact` additionally deletes the contact related to the portal user, once the portal user itself was deleted (`synchronous` mode only).
|
|
1626
|
+
*
|
|
1627
|
+
* The expected response http status code to the call is:
|
|
1628
|
+
* - 2xx if the request was accepted
|
|
1629
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
1630
|
+
*
|
|
1631
|
+
*/
|
|
1632
|
+
PortalExtensionHookDeleteAccount)[];
|
|
1596
1633
|
links?: {
|
|
1597
1634
|
/**
|
|
1598
1635
|
* Identifier of the link. Should not change between updates.
|
|
@@ -1622,6 +1659,159 @@ declare namespace Components {
|
|
|
1622
1659
|
};
|
|
1623
1660
|
}[];
|
|
1624
1661
|
}
|
|
1662
|
+
/**
|
|
1663
|
+
* Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not run its own change email flow. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change.
|
|
1664
|
+
* The `change_mode` controls what the portal does after the call:
|
|
1665
|
+
* - `asynchronous`: The third-party system takes the email change over entirely (most likely by sending the user instructions to confirm the new email address). The portal does not change the login email itself.
|
|
1666
|
+
* - `synchronous`: The third-party system applies the email change immediately. The portal waits for a successful (2xx) response and then also changes the portal user's login email right away, without sending a confirmation email. The user has to sign in again with the new email address afterwards.
|
|
1667
|
+
*
|
|
1668
|
+
* The expected response http status code to the call is:
|
|
1669
|
+
* - 2xx if the request was accepted
|
|
1670
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
1671
|
+
*
|
|
1672
|
+
*/
|
|
1673
|
+
export interface PortalExtensionHookChangeEmail {
|
|
1674
|
+
/**
|
|
1675
|
+
* Identifier of the hook. Should not change between updates.
|
|
1676
|
+
*/
|
|
1677
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1678
|
+
name?: TranslatedString;
|
|
1679
|
+
type: "changeEmail";
|
|
1680
|
+
/**
|
|
1681
|
+
* Controls how the email change is handled once the third-party system accepted it. `asynchronous` hands the email change over entirely to the third-party system and the portal does not change the login email itself. `synchronous` waits for the third-party system to respond and then changes the portal user's login email immediately, without a confirmation email.
|
|
1682
|
+
*
|
|
1683
|
+
*/
|
|
1684
|
+
change_mode?: "synchronous" | "asynchronous";
|
|
1685
|
+
/**
|
|
1686
|
+
* Whether the portal user must confirm their current password before the change email request is handed over to the third-party system. When true, the portal collects and verifies the current password before calling the hook. Treated as true when `change_mode` is `synchronous`, since the portal re-creates the login with the confirmed password. Skipped either way for portal users whose identity is managed by an identity provider: an SSO login has no password to confirm.
|
|
1687
|
+
*
|
|
1688
|
+
*/
|
|
1689
|
+
require_password_confirmation?: boolean;
|
|
1690
|
+
/**
|
|
1691
|
+
* Optional explanation shown to the user in the change email confirmation dialog.
|
|
1692
|
+
*/
|
|
1693
|
+
explanation?: {
|
|
1694
|
+
[name: string]: string;
|
|
1695
|
+
/**
|
|
1696
|
+
* Explanation of the functionality shown to the end user.
|
|
1697
|
+
* example:
|
|
1698
|
+
* You will receive an email with instructions to confirm your new email address.
|
|
1699
|
+
*/
|
|
1700
|
+
en: string;
|
|
1701
|
+
};
|
|
1702
|
+
auth?: PortalExtensionAuthBlock;
|
|
1703
|
+
call: {
|
|
1704
|
+
/**
|
|
1705
|
+
* HTTP method to use for the call
|
|
1706
|
+
*/
|
|
1707
|
+
method?: string;
|
|
1708
|
+
/**
|
|
1709
|
+
* URL to call. Supports variable interpolation.
|
|
1710
|
+
*/
|
|
1711
|
+
url: string;
|
|
1712
|
+
/**
|
|
1713
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1714
|
+
*/
|
|
1715
|
+
params?: {
|
|
1716
|
+
[name: string]: string;
|
|
1717
|
+
};
|
|
1718
|
+
/**
|
|
1719
|
+
* Headers to use. Supports variable interpolation.
|
|
1720
|
+
*/
|
|
1721
|
+
headers: {
|
|
1722
|
+
[name: string]: string;
|
|
1723
|
+
};
|
|
1724
|
+
/**
|
|
1725
|
+
* Optional JSON body to use for the call. Defaults to an object with the requested new email and portal user context, e.g. `{"new_email": "...", "old_email": "...", "portal_user_id": "..."}`. The requested new email is available as `{{Input.new_email}}` and the current account email as `{{Input.old_email}}`. Supports variable interpolation.
|
|
1726
|
+
*/
|
|
1727
|
+
body?: {
|
|
1728
|
+
[key: string]: any;
|
|
1729
|
+
};
|
|
1730
|
+
};
|
|
1731
|
+
resolved?: {
|
|
1732
|
+
/**
|
|
1733
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
1734
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
1735
|
+
*
|
|
1736
|
+
* example:
|
|
1737
|
+
* error.message
|
|
1738
|
+
*/
|
|
1739
|
+
error_message_path?: string;
|
|
1740
|
+
};
|
|
1741
|
+
secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
|
|
1742
|
+
}
|
|
1743
|
+
/**
|
|
1744
|
+
* Hook that replaces the built-in change password functionality for portal users. When configured, the portal does not change the user's password itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the password change (most likely by sending the user instructions to complete the process).
|
|
1745
|
+
* The expected response http status code to the call is:
|
|
1746
|
+
* - 2xx if the request was accepted
|
|
1747
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
1748
|
+
*
|
|
1749
|
+
*/
|
|
1750
|
+
export interface PortalExtensionHookChangePassword {
|
|
1751
|
+
/**
|
|
1752
|
+
* Identifier of the hook. Should not change between updates.
|
|
1753
|
+
*/
|
|
1754
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
1755
|
+
name?: TranslatedString;
|
|
1756
|
+
type: "changePassword";
|
|
1757
|
+
/**
|
|
1758
|
+
* Whether the portal user must provide a new password. When false, the portal only asks the user to confirm (showing the configured explanation) and no new password is collected; the third-party system is expected to handle the password change. When true, the portal collects a new password and passes it to the third-party system as `{{Input.new_password}}`.
|
|
1759
|
+
*
|
|
1760
|
+
*/
|
|
1761
|
+
require_new_password?: boolean;
|
|
1762
|
+
/**
|
|
1763
|
+
* Optional explanation shown to the user in the change password confirmation dialog.
|
|
1764
|
+
*/
|
|
1765
|
+
explanation?: {
|
|
1766
|
+
[name: string]: string;
|
|
1767
|
+
/**
|
|
1768
|
+
* Explanation of the functionality shown to the end user.
|
|
1769
|
+
* example:
|
|
1770
|
+
* You will receive an email with instructions to reset your password.
|
|
1771
|
+
*/
|
|
1772
|
+
en: string;
|
|
1773
|
+
};
|
|
1774
|
+
auth?: PortalExtensionAuthBlock;
|
|
1775
|
+
call: {
|
|
1776
|
+
/**
|
|
1777
|
+
* HTTP method to use for the call
|
|
1778
|
+
*/
|
|
1779
|
+
method?: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* URL to call. Supports variable interpolation.
|
|
1782
|
+
*/
|
|
1783
|
+
url: string;
|
|
1784
|
+
/**
|
|
1785
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
1786
|
+
*/
|
|
1787
|
+
params?: {
|
|
1788
|
+
[name: string]: string;
|
|
1789
|
+
};
|
|
1790
|
+
/**
|
|
1791
|
+
* Headers to use. Supports variable interpolation.
|
|
1792
|
+
*/
|
|
1793
|
+
headers: {
|
|
1794
|
+
[name: string]: string;
|
|
1795
|
+
};
|
|
1796
|
+
/**
|
|
1797
|
+
* Optional JSON body to use for the call. Defaults to an object with portal user context (and the new password as `{{Input.new_password}}` when `require_new_password` is true). Supports variable interpolation.
|
|
1798
|
+
*/
|
|
1799
|
+
body?: {
|
|
1800
|
+
[key: string]: any;
|
|
1801
|
+
};
|
|
1802
|
+
};
|
|
1803
|
+
resolved?: {
|
|
1804
|
+
/**
|
|
1805
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
1806
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
1807
|
+
*
|
|
1808
|
+
* example:
|
|
1809
|
+
* error.message
|
|
1810
|
+
*/
|
|
1811
|
+
error_message_path?: string;
|
|
1812
|
+
};
|
|
1813
|
+
secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
|
|
1814
|
+
}
|
|
1625
1815
|
/**
|
|
1626
1816
|
* Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
|
|
1627
1817
|
* - 200 with the time series data
|
|
@@ -1933,6 +2123,89 @@ declare namespace Components {
|
|
|
1933
2123
|
use_static_ips?: boolean;
|
|
1934
2124
|
secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
|
|
1935
2125
|
}
|
|
2126
|
+
/**
|
|
2127
|
+
* Hook that replaces the built-in delete account functionality for portal users. When configured, the portal does not delete the user itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the deletion.
|
|
2128
|
+
* The `deletion_mode` controls what the portal does after the call:
|
|
2129
|
+
* - `synchronous`: The third-party system deletes the user immediately. The portal waits for a successful (2xx) response and then also deletes the corresponding epilot Cognito user.
|
|
2130
|
+
* - `asynchronous`: The third-party system handles deletion out-of-band. The portal does not delete anything immediately; cleanup is expected to happen later (e.g. via the user deletion API or webhooks).
|
|
2131
|
+
*
|
|
2132
|
+
* The optional `delete_contact` additionally deletes the contact related to the portal user, once the portal user itself was deleted (`synchronous` mode only).
|
|
2133
|
+
*
|
|
2134
|
+
* The expected response http status code to the call is:
|
|
2135
|
+
* - 2xx if the request was accepted
|
|
2136
|
+
* - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
|
|
2137
|
+
*
|
|
2138
|
+
*/
|
|
2139
|
+
export interface PortalExtensionHookDeleteAccount {
|
|
2140
|
+
/**
|
|
2141
|
+
* Identifier of the hook. Should not change between updates.
|
|
2142
|
+
*/
|
|
2143
|
+
id: string; // ^[a-zA-Z0-9_-]+$
|
|
2144
|
+
name?: TranslatedString;
|
|
2145
|
+
type: "deleteAccount";
|
|
2146
|
+
/**
|
|
2147
|
+
* Controls how the account deletion is handled. `synchronous` waits for the third-party system to respond and then also deletes the epilot user. `asynchronous` hands the deletion over entirely to the third-party system and the portal does not delete anything immediately.
|
|
2148
|
+
*
|
|
2149
|
+
*/
|
|
2150
|
+
deletion_mode?: "synchronous" | "asynchronous";
|
|
2151
|
+
/**
|
|
2152
|
+
* Opt-in deletion of the contact related to the portal user, applied after the portal user itself was deleted. `none` (default) leaves the contact untouched. `soft` deletes the contact, so it can still be restored from the trash. `hard` permanently purges the contact. Only applied in `synchronous` deletion mode, as `asynchronous` mode hands the cleanup over to the third-party system.
|
|
2153
|
+
*
|
|
2154
|
+
*/
|
|
2155
|
+
delete_contact?: "none" | "soft" | "hard";
|
|
2156
|
+
/**
|
|
2157
|
+
* Optional explanation shown to the user in the delete account confirmation dialog.
|
|
2158
|
+
*/
|
|
2159
|
+
explanation?: {
|
|
2160
|
+
[name: string]: string;
|
|
2161
|
+
/**
|
|
2162
|
+
* Explanation of the functionality shown to the end user.
|
|
2163
|
+
* example:
|
|
2164
|
+
* Your account deletion will be processed by our system. This may take a few days.
|
|
2165
|
+
*/
|
|
2166
|
+
en: string;
|
|
2167
|
+
};
|
|
2168
|
+
auth?: PortalExtensionAuthBlock;
|
|
2169
|
+
call: {
|
|
2170
|
+
/**
|
|
2171
|
+
* HTTP method to use for the call
|
|
2172
|
+
*/
|
|
2173
|
+
method?: string;
|
|
2174
|
+
/**
|
|
2175
|
+
* URL to call. Supports variable interpolation.
|
|
2176
|
+
*/
|
|
2177
|
+
url: string;
|
|
2178
|
+
/**
|
|
2179
|
+
* Parameters to append to the URL. Supports variable interpolation.
|
|
2180
|
+
*/
|
|
2181
|
+
params?: {
|
|
2182
|
+
[name: string]: string;
|
|
2183
|
+
};
|
|
2184
|
+
/**
|
|
2185
|
+
* Headers to use. Supports variable interpolation.
|
|
2186
|
+
*/
|
|
2187
|
+
headers: {
|
|
2188
|
+
[name: string]: string;
|
|
2189
|
+
};
|
|
2190
|
+
/**
|
|
2191
|
+
* Optional JSON body to use for the call. Defaults to an object with portal user context, e.g. `{"portal_user_id": "...", "email": "..."}`. Supports variable interpolation.
|
|
2192
|
+
*/
|
|
2193
|
+
body?: {
|
|
2194
|
+
[key: string]: any;
|
|
2195
|
+
};
|
|
2196
|
+
};
|
|
2197
|
+
resolved?: {
|
|
2198
|
+
/**
|
|
2199
|
+
* Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
|
|
2200
|
+
* If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
|
|
2201
|
+
*
|
|
2202
|
+
* example:
|
|
2203
|
+
* error.message
|
|
2204
|
+
*/
|
|
2205
|
+
error_message_path?: string;
|
|
2206
|
+
};
|
|
2207
|
+
secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
|
|
2208
|
+
}
|
|
1936
2209
|
/**
|
|
1937
2210
|
* Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
|
|
1938
2211
|
* - 200:
|
|
@@ -2984,6 +3257,18 @@ declare namespace Paths {
|
|
|
2984
3257
|
}
|
|
2985
3258
|
}
|
|
2986
3259
|
}
|
|
3260
|
+
namespace PublicProxyDelete {
|
|
3261
|
+
namespace Responses {
|
|
3262
|
+
export interface $200 {
|
|
3263
|
+
}
|
|
3264
|
+
export interface $403 {
|
|
3265
|
+
}
|
|
3266
|
+
export interface $404 {
|
|
3267
|
+
}
|
|
3268
|
+
export interface $502 {
|
|
3269
|
+
}
|
|
3270
|
+
}
|
|
3271
|
+
}
|
|
2987
3272
|
namespace PublicProxyGet {
|
|
2988
3273
|
namespace Responses {
|
|
2989
3274
|
export interface $200 {
|
|
@@ -2996,6 +3281,20 @@ declare namespace Paths {
|
|
|
2996
3281
|
}
|
|
2997
3282
|
}
|
|
2998
3283
|
}
|
|
3284
|
+
namespace PublicProxyPatch {
|
|
3285
|
+
export interface RequestBody {
|
|
3286
|
+
}
|
|
3287
|
+
namespace Responses {
|
|
3288
|
+
export interface $200 {
|
|
3289
|
+
}
|
|
3290
|
+
export interface $403 {
|
|
3291
|
+
}
|
|
3292
|
+
export interface $404 {
|
|
3293
|
+
}
|
|
3294
|
+
export interface $502 {
|
|
3295
|
+
}
|
|
3296
|
+
}
|
|
3297
|
+
}
|
|
2999
3298
|
namespace PublicProxyPost {
|
|
3000
3299
|
export interface RequestBody {
|
|
3001
3300
|
}
|
|
@@ -3010,6 +3309,20 @@ declare namespace Paths {
|
|
|
3010
3309
|
}
|
|
3011
3310
|
}
|
|
3012
3311
|
}
|
|
3312
|
+
namespace PublicProxyPut {
|
|
3313
|
+
export interface RequestBody {
|
|
3314
|
+
}
|
|
3315
|
+
namespace Responses {
|
|
3316
|
+
export interface $200 {
|
|
3317
|
+
}
|
|
3318
|
+
export interface $403 {
|
|
3319
|
+
}
|
|
3320
|
+
export interface $404 {
|
|
3321
|
+
}
|
|
3322
|
+
export interface $502 {
|
|
3323
|
+
}
|
|
3324
|
+
}
|
|
3325
|
+
}
|
|
3013
3326
|
namespace QueryEvents {
|
|
3014
3327
|
namespace Parameters {
|
|
3015
3328
|
export type AppId = string;
|
|
@@ -3401,6 +3714,16 @@ interface OperationMethods {
|
|
|
3401
3714
|
data?: any,
|
|
3402
3715
|
config?: AxiosRequestConfig
|
|
3403
3716
|
): OperationResponse<Paths.PublicProxyGet.Responses.$200>
|
|
3717
|
+
/**
|
|
3718
|
+
* publicProxyPut - publicProxyPut
|
|
3719
|
+
*
|
|
3720
|
+
* Forward a PUT request to a registered proxy target from a public-facing component
|
|
3721
|
+
*/
|
|
3722
|
+
'publicProxyPut'(
|
|
3723
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
3724
|
+
data?: Paths.PublicProxyPut.RequestBody,
|
|
3725
|
+
config?: AxiosRequestConfig
|
|
3726
|
+
): OperationResponse<Paths.PublicProxyPut.Responses.$200>
|
|
3404
3727
|
/**
|
|
3405
3728
|
* publicProxyPost - publicProxyPost
|
|
3406
3729
|
*
|
|
@@ -3411,6 +3734,26 @@ interface OperationMethods {
|
|
|
3411
3734
|
data?: Paths.PublicProxyPost.RequestBody,
|
|
3412
3735
|
config?: AxiosRequestConfig
|
|
3413
3736
|
): OperationResponse<Paths.PublicProxyPost.Responses.$200>
|
|
3737
|
+
/**
|
|
3738
|
+
* publicProxyPatch - publicProxyPatch
|
|
3739
|
+
*
|
|
3740
|
+
* Forward a PATCH request to a registered proxy target from a public-facing component
|
|
3741
|
+
*/
|
|
3742
|
+
'publicProxyPatch'(
|
|
3743
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
3744
|
+
data?: Paths.PublicProxyPatch.RequestBody,
|
|
3745
|
+
config?: AxiosRequestConfig
|
|
3746
|
+
): OperationResponse<Paths.PublicProxyPatch.Responses.$200>
|
|
3747
|
+
/**
|
|
3748
|
+
* publicProxyDelete - publicProxyDelete
|
|
3749
|
+
*
|
|
3750
|
+
* Forward a DELETE request to a registered proxy target from a public-facing component
|
|
3751
|
+
*/
|
|
3752
|
+
'publicProxyDelete'(
|
|
3753
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
3754
|
+
data?: any,
|
|
3755
|
+
config?: AxiosRequestConfig
|
|
3756
|
+
): OperationResponse<Paths.PublicProxyDelete.Responses.$200>
|
|
3414
3757
|
}
|
|
3415
3758
|
|
|
3416
3759
|
interface PathsDictionary {
|
|
@@ -3774,6 +4117,36 @@ interface PathsDictionary {
|
|
|
3774
4117
|
data?: Paths.PublicProxyPost.RequestBody,
|
|
3775
4118
|
config?: AxiosRequestConfig
|
|
3776
4119
|
): OperationResponse<Paths.PublicProxyPost.Responses.$200>
|
|
4120
|
+
/**
|
|
4121
|
+
* publicProxyPut - publicProxyPut
|
|
4122
|
+
*
|
|
4123
|
+
* Forward a PUT request to a registered proxy target from a public-facing component
|
|
4124
|
+
*/
|
|
4125
|
+
'put'(
|
|
4126
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4127
|
+
data?: Paths.PublicProxyPut.RequestBody,
|
|
4128
|
+
config?: AxiosRequestConfig
|
|
4129
|
+
): OperationResponse<Paths.PublicProxyPut.Responses.$200>
|
|
4130
|
+
/**
|
|
4131
|
+
* publicProxyPatch - publicProxyPatch
|
|
4132
|
+
*
|
|
4133
|
+
* Forward a PATCH request to a registered proxy target from a public-facing component
|
|
4134
|
+
*/
|
|
4135
|
+
'patch'(
|
|
4136
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4137
|
+
data?: Paths.PublicProxyPatch.RequestBody,
|
|
4138
|
+
config?: AxiosRequestConfig
|
|
4139
|
+
): OperationResponse<Paths.PublicProxyPatch.Responses.$200>
|
|
4140
|
+
/**
|
|
4141
|
+
* publicProxyDelete - publicProxyDelete
|
|
4142
|
+
*
|
|
4143
|
+
* Forward a DELETE request to a registered proxy target from a public-facing component
|
|
4144
|
+
*/
|
|
4145
|
+
'delete'(
|
|
4146
|
+
parameters?: Parameters<Paths.V1PublicApp$AppIdProxy$ProxyName$Path.PathParameters> | null,
|
|
4147
|
+
data?: any,
|
|
4148
|
+
config?: AxiosRequestConfig
|
|
4149
|
+
): OperationResponse<Paths.PublicProxyDelete.Responses.$200>
|
|
3777
4150
|
}
|
|
3778
4151
|
}
|
|
3779
4152
|
|
|
@@ -3834,10 +4207,13 @@ type PortalBlockSurfaceConfig = Components.Schemas.PortalBlockSurfaceConfig;
|
|
|
3834
4207
|
type PortalExtensionAuthBlock = Components.Schemas.PortalExtensionAuthBlock;
|
|
3835
4208
|
type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
|
|
3836
4209
|
type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
|
|
4210
|
+
type PortalExtensionHookChangeEmail = Components.Schemas.PortalExtensionHookChangeEmail;
|
|
4211
|
+
type PortalExtensionHookChangePassword = Components.Schemas.PortalExtensionHookChangePassword;
|
|
3837
4212
|
type PortalExtensionHookConsumptionDataRetrieval = Components.Schemas.PortalExtensionHookConsumptionDataRetrieval;
|
|
3838
4213
|
type PortalExtensionHookContractIdentification = Components.Schemas.PortalExtensionHookContractIdentification;
|
|
3839
4214
|
type PortalExtensionHookCostDataRetrieval = Components.Schemas.PortalExtensionHookCostDataRetrieval;
|
|
3840
4215
|
type PortalExtensionHookDataExport = Components.Schemas.PortalExtensionHookDataExport;
|
|
4216
|
+
type PortalExtensionHookDeleteAccount = Components.Schemas.PortalExtensionHookDeleteAccount;
|
|
3841
4217
|
type PortalExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.PortalExtensionHookMeterReadingPlausibilityCheck;
|
|
3842
4218
|
type PortalExtensionHookPriceDataRetrieval = Components.Schemas.PortalExtensionHookPriceDataRetrieval;
|
|
3843
4219
|
type PortalExtensionHookRegistrationIdentifiersCheck = Components.Schemas.PortalExtensionHookRegistrationIdentifiersCheck;
|
|
@@ -3854,4 +4230,4 @@ type SandboxCustomActionConfig = Components.Schemas.SandboxCustomActionConfig;
|
|
|
3854
4230
|
type TextArg = Components.Schemas.TextArg;
|
|
3855
4231
|
type TranslatedString = Components.Schemas.TranslatedString;
|
|
3856
4232
|
|
|
3857
|
-
export { type PortalBlockComponent as $, type Actor as A, type BaseComponent as B, type Client as C, type ErpInformToolkitComponent as D, type EnumArg as E, type EventsQuery as F, type EventsQueryResponse as G, type ExternalIntegrationCustomActionConfig as H, type ExternalProductCatalogAuthBlock as I, type ExternalProductCatalogComponent as J, type ExternalProductCatalogConfig as K, type ExternalProductCatalogHookProductRecommendations as L, type ExternalProductCatalogHookProducts as M, type Grants as N, type OperationMethods as O, Paths as P, type Installation as Q, type JourneyBlockComponent as R, type JourneyBlockComponentArgs as S, type JourneyBlockConfig as T, type NotificationConfig as U, type NotificationEvent as V, type ObjectField as W, type Option as X, type Options as Y, type OptionsRef as Z, type OverrideDevMode as _, Components as a, type PortalBlockConfig as a0, type PortalBlockSurfaceConfig as a1, type PortalExtensionAuthBlock as a2, type PortalExtensionComponent as a3, type PortalExtensionConfig as a4, type
|
|
4233
|
+
export { type PortalBlockComponent as $, type Actor as A, type BaseComponent as B, type Client as C, type ErpInformToolkitComponent as D, type EnumArg as E, type EventsQuery as F, type EventsQueryResponse as G, type ExternalIntegrationCustomActionConfig as H, type ExternalProductCatalogAuthBlock as I, type ExternalProductCatalogComponent as J, type ExternalProductCatalogConfig as K, type ExternalProductCatalogHookProductRecommendations as L, type ExternalProductCatalogHookProducts as M, type Grants as N, type OperationMethods as O, Paths as P, type Installation as Q, type JourneyBlockComponent as R, type JourneyBlockComponentArgs as S, type JourneyBlockConfig as T, type NotificationConfig as U, type NotificationEvent as V, type ObjectField as W, type Option as X, type Options as Y, type OptionsRef as Z, type OverrideDevMode as _, Components as a, type PortalBlockConfig as a0, type PortalBlockSurfaceConfig as a1, type PortalExtensionAuthBlock as a2, type PortalExtensionComponent as a3, type PortalExtensionConfig as a4, type PortalExtensionHookChangeEmail as a5, type PortalExtensionHookChangePassword as a6, type PortalExtensionHookConsumptionDataRetrieval as a7, type PortalExtensionHookContractIdentification as a8, type PortalExtensionHookCostDataRetrieval as a9, type PortalExtensionHookDataExport as aa, type PortalExtensionHookDeleteAccount as ab, type PortalExtensionHookMeterReadingPlausibilityCheck as ac, type PortalExtensionHookPriceDataRetrieval as ad, type PortalExtensionHookRegistrationIdentifiersCheck as ae, type PortalExtensionHookVisualizationMetadata as af, type PortalExtensionSeamlessLink as ag, type PortalExtensionSecureProxy as ah, type Pricing as ai, type PublicConfiguration as aj, type RawEvents as ak, type Review as al, type Role as am, type S3Reference as an, type SandboxCustomActionConfig as ao, type TextArg as ap, type TranslatedString as aq, type PathsDictionary as b, type AggregatedEvents as c, type ApiProxyComponent as d, type ApiProxyConfig as e, type AppBridgeSurfaceConfig as f, type AppEventData as g, type Audit as h, type Author as i, type BaseComponentCommon as j, type BaseCustomActionConfig as k, type BatchEventRequest as l, type BillingFrequency as m, type BlockReferenceArg as n, type BlueprintRef as o, type BooleanArg as p, type CallerIdentity as q, type ComponentType as r, type Configuration as s, type ConfigurationMetadata as t, type ConfigurationVersion as u, type CustomCapabilityComponent as v, type CustomFlowActionComponent as w, type CustomFlowConfig as x, type CustomPageComponent as y, type CustomPageConfig as z };
|