@epilot/app-client 0.13.2 → 0.13.4

package/dist/openapi.d.ts

@@ -1595,7 +1595,32 @@ declare namespace Components {
              * 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.
              *
              */
-            PortalExtensionHookVisualizationMetadata)[];
+            PortalExtensionHookVisualizationMetadata | /**
+             * Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not change the user's login email itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change (most likely by sending the user instructions to confirm the new email address).
+             * The expected response http status code to the call is:
+             *   - 2xx if the request was accepted
+             *   - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
+             *
+             */
+            PortalExtensionHookChangeEmail | /**
+             * 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).
+             * The expected response http status code to the call is:
+             *   - 2xx if the request was accepted
+             *   - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
+             *
+             */
+            PortalExtensionHookChangePassword | /**
+             * 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.
+             * The `deletion_mode` controls what the portal does after the call:
+             *   - `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.
+             *   - `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).
+             *
+             * The expected response http status code to the call is:
+             *   - 2xx if the request was accepted
+             *   - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
+             *
+             */
+            PortalExtensionHookDeleteAccount)[];
             links?: {
                 /**
                  * Identifier of the link. Should not change between updates.
@@ -1625,6 +1650,150 @@ declare namespace Components {
                 };
             }[];
         }
+        /**
+         * Hook that replaces the built-in change email functionality for portal users. When configured, the portal does not change the user's login email itself. Instead, this hook makes an HTTP call to the third-party system, which is expected to handle the email change (most likely by sending the user instructions to confirm the new email address).
+         * The expected response http status code to the call is:
+         *   - 2xx if the request was accepted
+         *   - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
+         *
+         */
+        export interface PortalExtensionHookChangeEmail {
+            /**
+             * Identifier of the hook. Should not change between updates.
+             */
+            id: string; // ^[a-zA-Z0-9_-]+$
+            name?: TranslatedString;
+            type: "changeEmail";
+            /**
+             * 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.
+             *
+             */
+            require_password_confirmation?: boolean;
+            /**
+             * Optional explanation shown to the user in the change email confirmation dialog.
+             */
+            explanation?: {
+                [name: string]: string;
+                /**
+                 * Explanation of the functionality shown to the end user.
+                 * example:
+                 * You will receive an email with instructions to confirm your new email address.
+                 */
+                en: string;
+            };
+            auth?: PortalExtensionAuthBlock;
+            call: {
+                /**
+                 * HTTP method to use for the call
+                 */
+                method?: string;
+                /**
+                 * URL to call. Supports variable interpolation.
+                 */
+                url: string;
+                /**
+                 * Parameters to append to the URL. Supports variable interpolation.
+                 */
+                params?: {
+                    [name: string]: string;
+                };
+                /**
+                 * Headers to use. Supports variable interpolation.
+                 */
+                headers: {
+                    [name: string]: string;
+                };
+                /**
+                 * 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.
+                 */
+                body?: {
+                    [key: string]: any;
+                };
+            };
+            resolved?: {
+                /**
+                 * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
+                 * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
+                 *
+                 * example:
+                 * error.message
+                 */
+                error_message_path?: string;
+            };
+            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
+        }
+        /**
+         * 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).
+         * The expected response http status code to the call is:
+         *   - 2xx if the request was accepted
+         *   - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
+         *
+         */
+        export interface PortalExtensionHookChangePassword {
+            /**
+             * Identifier of the hook. Should not change between updates.
+             */
+            id: string; // ^[a-zA-Z0-9_-]+$
+            name?: TranslatedString;
+            type: "changePassword";
+            /**
+             * 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}}`.
+             *
+             */
+            require_new_password?: boolean;
+            /**
+             * Optional explanation shown to the user in the change password confirmation dialog.
+             */
+            explanation?: {
+                [name: string]: string;
+                /**
+                 * Explanation of the functionality shown to the end user.
+                 * example:
+                 * You will receive an email with instructions to reset your password.
+                 */
+                en: string;
+            };
+            auth?: PortalExtensionAuthBlock;
+            call: {
+                /**
+                 * HTTP method to use for the call
+                 */
+                method?: string;
+                /**
+                 * URL to call. Supports variable interpolation.
+                 */
+                url: string;
+                /**
+                 * Parameters to append to the URL. Supports variable interpolation.
+                 */
+                params?: {
+                    [name: string]: string;
+                };
+                /**
+                 * Headers to use. Supports variable interpolation.
+                 */
+                headers: {
+                    [name: string]: string;
+                };
+                /**
+                 * 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.
+                 */
+                body?: {
+                    [key: string]: any;
+                };
+            };
+            resolved?: {
+                /**
+                 * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
+                 * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
+                 *
+                 * example:
+                 * error.message
+                 */
+                error_message_path?: string;
+            };
+            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
+        }
         /**
          * 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:
          *   - 200 with the time series data
@@ -1676,6 +1845,10 @@ declare namespace Components {
                 /**
                  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
                  */
+                data_path?: string;
+                /**
+                 * Deprecated. Use `data_path` instead.
+                 */
                 dataPath?: string;
                 /**
                  * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
@@ -1684,7 +1857,7 @@ declare namespace Components {
                  * example:
                  * error.message
                  */
-                errorMessagePath?: string;
+                error_message_path?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -1760,7 +1933,7 @@ declare namespace Components {
                  * example:
                  * error.message
                  */
-                errorMessagePath?: string;
+                error_message_path?: string;
             };
             /**
              * Mode of contract assignment. See hook description for mode details.
@@ -1843,6 +2016,10 @@ declare namespace Components {
                 /**
                  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
                  */
+                data_path?: string;
+                /**
+                 * Deprecated. Use `data_path` instead.
+                 */
                 dataPath?: string;
                 /**
                  * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
@@ -1851,7 +2028,7 @@ declare namespace Components {
                  * example:
                  * error.message
                  */
-                errorMessagePath?: string;
+                error_message_path?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -1918,7 +2095,7 @@ declare namespace Components {
                  * example:
                  * error.message
                  */
-                errorMessagePath?: string;
+                error_message_path?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -1928,6 +2105,82 @@ declare namespace Components {
             use_static_ips?: boolean;
             secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
         }
+        /**
+         * 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.
+         * The `deletion_mode` controls what the portal does after the call:
+         *   - `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.
+         *   - `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).
+         *
+         * The expected response http status code to the call is:
+         *   - 2xx if the request was accepted
+         *   - non-2xx if the request failed (optionally with a human-readable message resolved via `resolved.error_message_path`)
+         *
+         */
+        export interface PortalExtensionHookDeleteAccount {
+            /**
+             * Identifier of the hook. Should not change between updates.
+             */
+            id: string; // ^[a-zA-Z0-9_-]+$
+            name?: TranslatedString;
+            type: "deleteAccount";
+            /**
+             * 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.
+             *
+             */
+            deletion_mode?: "synchronous" | "asynchronous";
+            /**
+             * Optional explanation shown to the user in the delete account confirmation dialog.
+             */
+            explanation?: {
+                [name: string]: string;
+                /**
+                 * Explanation of the functionality shown to the end user.
+                 * example:
+                 * Your account deletion will be processed by our system. This may take a few days.
+                 */
+                en: string;
+            };
+            auth?: PortalExtensionAuthBlock;
+            call: {
+                /**
+                 * HTTP method to use for the call
+                 */
+                method?: string;
+                /**
+                 * URL to call. Supports variable interpolation.
+                 */
+                url: string;
+                /**
+                 * Parameters to append to the URL. Supports variable interpolation.
+                 */
+                params?: {
+                    [name: string]: string;
+                };
+                /**
+                 * Headers to use. Supports variable interpolation.
+                 */
+                headers: {
+                    [name: string]: string;
+                };
+                /**
+                 * 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.
+                 */
+                body?: {
+                    [key: string]: any;
+                };
+            };
+            resolved?: {
+                /**
+                 * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
+                 * If specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.
+                 *
+                 * example:
+                 * error.message
+                 */
+                error_message_path?: string;
+            };
+            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
+        }
         /**
          * 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:
          *   - 200:
@@ -1982,6 +2235,10 @@ declare namespace Components {
                  * example:
                  * data.results
                  */
+                data_path?: string;
+                /**
+                 * Deprecated. Use `data_path` instead.
+                 */
                 dataPath?: string;
                 /**
                  * Counter identifier(s) used to match against the meter's counters.
@@ -2022,7 +2279,7 @@ declare namespace Components {
                  * example:
                  * error.message
                  */
-                errorMessagePath?: string;
+                error_message_path?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -2083,6 +2340,10 @@ declare namespace Components {
                 /**
                  * Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level.
                  */
+                data_path?: string;
+                /**
+                 * Deprecated. Use `data_path` instead.
+                 */
                 dataPath?: string;
                 /**
                  * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
@@ -2091,7 +2352,7 @@ declare namespace Components {
                  * example:
                  * error.message
                  */
-                errorMessagePath?: string;
+                error_message_path?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -2159,7 +2420,7 @@ declare namespace Components {
                  * example:
                  * error.message
                  */
-                errorMessagePath?: string;
+                error_message_path?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -2229,6 +2490,10 @@ declare namespace Components {
                 /**
                  * Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level.
                  */
+                data_path?: string;
+                /**
+                 * Deprecated. Use `data_path` instead.
+                 */
                 dataPath?: string;
                 /**
                  * Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).
@@ -2237,7 +2502,7 @@ declare namespace Components {
                  * example:
                  * error.message
                  */
-                errorMessagePath?: string;
+                error_message_path?: string;
             };
             /**
              * Deprecated. Prefer `secure_proxy` instead.
@@ -3817,10 +4082,13 @@ export type PortalBlockSurfaceConfig = Components.Schemas.PortalBlockSurfaceConf
 export type PortalExtensionAuthBlock = Components.Schemas.PortalExtensionAuthBlock;
 export type PortalExtensionComponent = Components.Schemas.PortalExtensionComponent;
 export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
+export type PortalExtensionHookChangeEmail = Components.Schemas.PortalExtensionHookChangeEmail;
+export type PortalExtensionHookChangePassword = Components.Schemas.PortalExtensionHookChangePassword;
 export type PortalExtensionHookConsumptionDataRetrieval = Components.Schemas.PortalExtensionHookConsumptionDataRetrieval;
 export type PortalExtensionHookContractIdentification = Components.Schemas.PortalExtensionHookContractIdentification;
 export type PortalExtensionHookCostDataRetrieval = Components.Schemas.PortalExtensionHookCostDataRetrieval;
 export type PortalExtensionHookDataExport = Components.Schemas.PortalExtensionHookDataExport;
+export type PortalExtensionHookDeleteAccount = Components.Schemas.PortalExtensionHookDeleteAccount;
 export type PortalExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.PortalExtensionHookMeterReadingPlausibilityCheck;
 export type PortalExtensionHookPriceDataRetrieval = Components.Schemas.PortalExtensionHookPriceDataRetrieval;
 export type PortalExtensionHookRegistrationIdentifiersCheck = Components.Schemas.PortalExtensionHookRegistrationIdentifiersCheck;