@epilot/app-client 0.12.4 → 0.12.5

package/dist/openapi.d.ts

@@ -1497,11 +1497,11 @@ declare namespace Components {
              *
              */
             PortalExtensionHookConsumptionDataRetrieval | /**
-             * Hook that takes over the export of consumption data from the portal. When defined, the portal delegates exporting (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the export itself. This hook is triggered when an end user requests a consumption export. The expected response to the call is:
+             * Generic data export hook. When configured on blocks that support it, the portal delegates the export action (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the file itself. Can be used by any block that supports export — consumption charts, dynamic tariff charts, etc. The expected response to the call is:
              *   - 200 with a JSON body describing the exported file (download_url, optional filename, content_type, expires_at)
              *
              */
-            PortalExtensionHookConsumptionExport | /**
+            PortalExtensionHookDataExport | /**
              * 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
              *
@@ -1624,55 +1624,6 @@ 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 takes over the export of consumption data from the portal. When defined, the portal delegates exporting (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the export itself. This hook is triggered when an end user requests a consumption export. The expected response to the call is:
-         *   - 200 with a JSON body describing the exported file (download_url, optional filename, content_type, expires_at)
-         *
-         */
-        export interface PortalExtensionHookConsumptionExport {
-            /**
-             * Identifier of the hook. Should not change between updates.
-             */
-            id: string; // ^[a-zA-Z0-9_-]+$
-            name?: TranslatedString;
-            type: "consumptionExport";
-            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;
-                };
-                /**
-                 * Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
-                 */
-                body?: {
-                    [name: string]: any;
-                };
-            };
-            /**
-             * Deprecated. Prefer `secure_proxy` instead.
-             * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
-             *
-             */
-            use_static_ips?: boolean;
-            secure_proxy?: /* If set, requests are routed through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ PortalExtensionSecureProxy;
-        }
         /**
          * A consumption type advertised by a consumption data retrieval hook.
          */
@@ -1682,6 +1633,13 @@ declare namespace Components {
              */
             id: string;
             label: TranslatedString;
+            /**
+             * Optional grouping key. Types sharing the same aggregation_group are interpreted as values that can be aggregated (e.g. ht/nt shown as a stacked bar chart - summed into total consumption per interval). Types in different groups — or types without a group — are not (e.g. feed-in vs feed-out shown as separate bars).
+             *
+             * example:
+             * consumption
+             */
+            aggregation_group?: string;
         }
         /**
          * Hook that replaces the built-in Contract identification for self-assignment. This hook involves an HTTP request whenever a user is trying to self-assign Contract(s).
@@ -1826,6 +1784,55 @@ 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;
         }
+        /**
+         * Generic data export hook. When configured on blocks that support it, the portal delegates the export action (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the file itself. Can be used by any block that supports export — consumption charts, dynamic tariff charts, etc. The expected response to the call is:
+         *   - 200 with a JSON body describing the exported file (download_url, optional filename, content_type, expires_at)
+         *
+         */
+        export interface PortalExtensionHookDataExport {
+            /**
+             * Identifier of the hook. Should not change between updates.
+             */
+            id: string; // ^[a-zA-Z0-9_-]+$
+            name?: TranslatedString;
+            type: "dataExport";
+            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;
+                };
+                /**
+                 * Request body to send. Supports variable interpolation. Content format is determined by Content-Type header.
+                 */
+                body?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * Deprecated. Prefer `secure_proxy` instead.
+             * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
+             *
+             */
+            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 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:
@@ -3606,10 +3613,10 @@ export type PortalExtensionComponent = Components.Schemas.PortalExtensionCompone
 export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
 export type PortalExtensionHookConsumptionAggregationMethodOption = Components.Schemas.PortalExtensionHookConsumptionAggregationMethodOption;
 export type PortalExtensionHookConsumptionDataRetrieval = Components.Schemas.PortalExtensionHookConsumptionDataRetrieval;
-export type PortalExtensionHookConsumptionExport = Components.Schemas.PortalExtensionHookConsumptionExport;
 export type PortalExtensionHookConsumptionOption = Components.Schemas.PortalExtensionHookConsumptionOption;
 export type PortalExtensionHookContractIdentification = Components.Schemas.PortalExtensionHookContractIdentification;
 export type PortalExtensionHookCostDataRetrieval = Components.Schemas.PortalExtensionHookCostDataRetrieval;
+export type PortalExtensionHookDataExport = Components.Schemas.PortalExtensionHookDataExport;
 export type PortalExtensionHookMeterReadingPlausibilityCheck = Components.Schemas.PortalExtensionHookMeterReadingPlausibilityCheck;
 export type PortalExtensionHookPriceDataRetrieval = Components.Schemas.PortalExtensionHookPriceDataRetrieval;
 export type PortalExtensionHookRegistrationIdentifiersCheck = Components.Schemas.PortalExtensionHookRegistrationIdentifiersCheck;

package/dist/openapi.json

@@ -2609,7 +2609,7 @@
                   "contractIdentification": "#/components/schemas/PortalExtensionHookContractIdentification",
                   "priceDataRetrieval": "#/components/schemas/PortalExtensionHookPriceDataRetrieval",
                   "consumptionDataRetrieval": "#/components/schemas/PortalExtensionHookConsumptionDataRetrieval",
-                  "consumptionExport": "#/components/schemas/PortalExtensionHookConsumptionExport",
+                  "dataExport": "#/components/schemas/PortalExtensionHookDataExport",
                   "costDataRetrieval": "#/components/schemas/PortalExtensionHookCostDataRetrieval",
                   "meterReadingPlausibilityCheck": "#/components/schemas/PortalExtensionHookMeterReadingPlausibilityCheck"
                 }
@@ -2628,7 +2628,7 @@
                   "$ref": "#/components/schemas/PortalExtensionHookConsumptionDataRetrieval"
                 },
                 {
-                  "$ref": "#/components/schemas/PortalExtensionHookConsumptionExport"
+                  "$ref": "#/components/schemas/PortalExtensionHookDataExport"
                 },
                 {
                   "$ref": "#/components/schemas/PortalExtensionHookCostDataRetrieval"
@@ -3175,8 +3175,8 @@
         ],
         "additionalProperties": false
       },
-      "PortalExtensionHookConsumptionExport": {
-        "description": "Hook that takes over the export of consumption data from the portal. When defined, the portal delegates exporting (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the export itself. This hook is triggered when an end user requests a consumption export. The expected response to the call is:\n  - 200 with a JSON body describing the exported file (download_url, optional filename, content_type, expires_at)\n",
+      "PortalExtensionHookDataExport": {
+        "description": "Generic data export hook. When configured on blocks that support it, the portal delegates the export action (e.g. CSV/Excel/PDF download) to the configured external source instead of generating the file itself. Can be used by any block that supports export — consumption charts, dynamic tariff charts, etc. The expected response to the call is:\n  - 200 with a JSON body describing the exported file (download_url, optional filename, content_type, expires_at)\n",
         "type": "object",
         "properties": {
           "id": {
@@ -3190,7 +3190,7 @@
           "type": {
             "type": "string",
             "enum": [
-              "consumptionExport"
+              "dataExport"
             ]
           },
           "auth": {
@@ -3262,6 +3262,11 @@
           },
           "label": {
             "$ref": "#/components/schemas/TranslatedString"
+          },
+          "aggregation_group": {
+            "type": "string",
+            "description": "Optional grouping key. Types sharing the same aggregation_group are interpreted as values that can be aggregated (e.g. ht/nt shown as a stacked bar chart - summed into total consumption per interval). Types in different groups — or types without a group — are not (e.g. feed-in vs feed-out shown as separate bars).\n",
+            "example": "consumption"
           }
         },
         "required": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/app-client",
-  "version": "0.12.4",
+  "version": "0.12.5",
   "description": "JavaScript client library for the epilot App API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",