@epilot/sdk 2.19.14 → 2.20.1

package/dist/{app.d-BiknhSJo.d.cts → app.d-BHpFAvPW.d.cts}

@@ -5,6 +5,12 @@ import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, Unkno
 
 declare namespace Components {
     namespace RequestBodies {
+        export interface CloneVersionRequest {
+            /**
+             * Short description of what the new version will change
+             */
+            changelog?: string;
+        }
         export interface CreateBundlePresignedRequest {
             /**
              * Version of the app
@@ -116,7 +122,11 @@ declare namespace Components {
              * sensitive and must not declare `sensitive: false`.
              *
              */
-            options?: /* Options for the component configuration */ Schemas.Options[];
+            options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Schemas.Options[];
+            /**
+             * Short description of what changed in this version
+             */
+            changelog?: string;
         }
         export type UpsertComponentRequest = Schemas.BaseComponent;
     }
@@ -288,7 +298,7 @@ declare namespace Components {
             /**
              * List of options for the app component
              */
-            options?: /* Options for the component configuration */ Options[];
+            options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
             /**
              * Keys of app-level options this component uses. Narrows which options are
              * folded back into `options` for legacy consumers (e.g. which values a journey
@@ -301,7 +311,11 @@ declare namespace Components {
             surfaces?: {
                 [key: string]: any;
             };
-        } & (JourneyBlockComponent | PortalBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent | ExternalProductCatalogComponent | CustomPageComponent | ApiProxyComponent);
+        } & (JourneyBlockComponent | PortalBlockComponent | PortalExtensionComponent | CustomFlowActionComponent | ErpInformToolkitComponent | CustomCapabilityComponent | ExternalProductCatalogComponent | CustomPageComponent | ApiProxyComponent | /**
+         * Exposes typed values resolved from an external system at runtime (e.g. a meter reading prediction). Consumers such as validation rules reference a hook and one of its results by id. Resolution is performed by the external-values-api on behalf of authenticated epilot 360 users and portal end customers.
+         *
+         */
+        ExternalValuesComponent);
         export interface BaseComponentCommon {
             /**
              * Unique identifier for the component
@@ -336,7 +350,7 @@ declare namespace Components {
             /**
              * List of options for the app component
              */
-            options?: /* Options for the component configuration */ Options[];
+            options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
             /**
              * Keys of app-level options this component uses. Narrows which options are
              * folded back into `options` for legacy consumers (e.g. which values a journey
@@ -534,7 +548,7 @@ declare namespace Components {
         /**
          * Type of app component
          */
-        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE" | "API_PROXY" | "APP_FUNCTION";
+        export type ComponentType = "CUSTOM_JOURNEY_BLOCK" | "CUSTOM_PORTAL_BLOCK" | "PORTAL_EXTENSION" | "CUSTOM_FLOW_ACTION" | "ERP_INFORM_TOOLKIT" | "CUSTOM_CAPABILITY" | "EXTERNAL_PRODUCT_CATALOG" | "CUSTOM_PAGE" | "API_PROXY" | "EXTERNAL_VALUES" | "APP_FUNCTION";
         /**
          * Configuration of the published app
          */
@@ -653,7 +667,7 @@ declare namespace Components {
             /**
              * App-level option declarations (with sensitivity) of this version
              */
-            options?: /* Options for the component configuration */ Options[];
+            options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
             /**
              * Visibility of the app version
              */
@@ -843,7 +857,7 @@ declare namespace Components {
             /**
              * App-level option declarations (with sensitivity) of this version
              */
-            options?: /* Options for the component configuration */ Options[];
+            options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
             /**
              * Visibility of the app version
              */
@@ -1251,6 +1265,167 @@ declare namespace Components {
                 };
             };
         }
+        /**
+         * Exposes typed values resolved from an external system at runtime (e.g. a meter reading prediction). Consumers such as validation rules reference a hook and one of its results by id. Resolution is performed by the external-values-api on behalf of authenticated epilot 360 users and portal end customers.
+         *
+         */
+        export interface ExternalValuesComponent {
+            component_type: "EXTERNAL_VALUES";
+            configuration: /* Configuration for an EXTERNAL_VALUES component */ ExternalValuesConfig;
+        }
+        /**
+         * Configuration for an EXTERNAL_VALUES component
+         */
+        export interface ExternalValuesConfig {
+            /**
+             * Hooks exposed by this component. Hook ids must be unique within the component.
+             */
+            hooks: /**
+             * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Input`, `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse`.
+             *
+             */
+            ExternalValuesHook[];
+        }
+        /**
+         * One external call that returns one or more typed results. Interpolated templates (Liquid) have access to `Input`, `Context`, `Consumer`, `Options`, `Env` and — for `result` templates — `Response` and `AuthResponse`.
+         *
+         */
+        export interface ExternalValuesHook {
+            /**
+             * Stable identifier; consumers (e.g. validation rules) reference it. Renaming breaks references.
+             */
+            id: string; // ^[a-zA-Z0-9_-]{1,100}$
+            name: TranslatedString;
+            description?: TranslatedString;
+            /**
+             * Static request authentication applied to the call.
+             * - `none`: no static authentication.
+             * - `header`: sends `auth_secret` in header `auth_header` (default `X-API-Key`).
+             * - `bearer`: sends `Authorization: Bearer <auth_secret>`.
+             * - `hmac`: signs the request per Standard Webhooks (headers `webhook-id`,
+             *   `webhook-timestamp`, `webhook-signature` = `v1,<base64 HMAC-SHA256>` over
+             *   `<id>.<timestamp>.<body>`) using `auth_secret` as a `whsec_`-prefixed
+             *   base64 secret, exactly as epilot webhooks do.
+             *
+             * `auth_secret` is required when `auth_type` is `header`, `bearer` or `hmac`.
+             * Combine with `auth` (a pre-call that fetches a token) when the target needs both.
+             *
+             */
+            auth_type?: "none" | "header" | "bearer" | "hmac";
+            /**
+             * Header name used when `auth_type` is `header`. Defaults to `X-API-Key`.
+             */
+            auth_header?: string;
+            /**
+             * Liquid template resolving to the secret, e.g. "{{Options.api_key}}". Must reference an option declared with `type: secret`; literals are rejected. Required when `auth_type` is `header`, `bearer` or `hmac`.
+             * example:
+             * {{Options.api_key}}
+             */
+            auth_secret?: string;
+            auth?: PortalExtensionAuthBlock;
+            call: {
+                /**
+                 * HTTP method to use for the call
+                 */
+                method?: "GET" | "POST" | "PUT" | "PATCH";
+                /**
+                 * URL to call. Supports variable interpolation.
+                 */
+                url: string;
+                /**
+                 * Headers to send with the call. Supports variable interpolation.
+                 */
+                headers?: {
+                    [name: string]: string;
+                };
+                /**
+                 * Query parameters to append to the URL. Supports variable interpolation.
+                 */
+                params?: {
+                    [name: string]: string;
+                };
+                /**
+                 * JSON body to send. Values support variable interpolation. When omitted, `{ Input, Context, Consumer }` is sent as-is.
+                 */
+                body?: {
+                    [name: string]: any;
+                };
+            };
+            /**
+             * Typed results extracted from the response. Result ids must be unique within the hook.
+             */
+            result: [
+                /**
+                 * A single typed value extracted from the hook response. Exactly one of `template`, `path` or `jsonata` must be set.
+                 *
+                 */
+                ExternalValuesResult,
+                .../**
+                 * A single typed value extracted from the hook response. Exactly one of `template`, `path` or `jsonata` must be set.
+                 *
+                 */
+                ExternalValuesResult[]
+            ];
+            /**
+             * Timeout for the external call in milliseconds.
+             */
+            timeout_ms?: number;
+            /**
+             * Behaviour when the external system is unavailable (timeout, network or upstream error). `skip`: consumers ignore conditions depending on this hook. `block`: consumers treat the dependent action as not allowed.
+             */
+            on_unavailable?: "skip" | "block";
+            /**
+             * Response caching. Off when omitted.
+             */
+            cache?: {
+                /**
+                 * Time to live in seconds. 0 disables caching.
+                 */
+                ttl_seconds: number;
+                /**
+                 * Liquid template for the cache key. Defaults to a hash of org, app, hook, `Input` and `Context`.
+                 */
+                key?: string;
+            };
+            /**
+             * If set, requests are sent from epilot's static egress IPs. Mutually exclusive with secure_proxy.
+             */
+            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 single typed value extracted from the hook response. Exactly one of `template`, `path` or `jsonata` must be set.
+         *
+         */
+        export interface ExternalValuesResult {
+            /**
+             * Stable identifier of the result within the hook. Renaming breaks references.
+             */
+            id: string; // ^[a-zA-Z0-9_-]{1,100}$
+            /**
+             * Type the extracted value is coerced to.
+             */
+            type: "number" | "text" | "date" | "boolean";
+            name: TranslatedString;
+            /**
+             * Liquid template over `Response` etc.; output coerced to `type`.
+             * example:
+             * {{Response.value}}
+             */
+            template?: string;
+            /**
+             * Dot path into the response body, e.g. "data.limit".
+             * example:
+             * data.limit
+             */
+            path?: string;
+            /**
+             * JSONata expression over `{ Response, Input, Context, Options, Env }`.
+             * example:
+             * $sum(Response.items.amount)
+             */
+            jsonata?: string;
+        }
         /**
          * A named server-side function belonging to the app. Runs in the epilot code-execution sandbox with an installation-scoped app token. Functions with a schedule are executed automatically once per installation.
          *
@@ -1402,7 +1577,7 @@ declare namespace Components {
              * `configured` and `value_updated_at` instead.
              *
              */
-            options?: /* Options for the component configuration */ Options[];
+            options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
             /**
              * Version of the app that is installed
              */
@@ -1615,7 +1790,7 @@ declare namespace Components {
             value: any;
         }
         /**
-         * Options for the component configuration
+         * An option declaration — a setting the installing org fills in. Declared at app level.
          */
         export interface Options {
             /**
@@ -1674,7 +1849,7 @@ declare namespace Components {
              * Write-only, server-side only value — like a sensitive environment variable
              * (app-level options only). Sensitive values are never serialized in any response;
              * they are resolvable only via server-side channels (API proxy injection, function
-             * `secrets` allowlist, the internal options/resolve endpoint). Non-sensitive values
+             * runs, the internal options/resolve endpoint). Non-sensitive values
              * are readable wherever the app runs, including the end-customer browser (journey and
              * portal runtime). Forced to true for `secret`-touching options. Default: false.
              *
@@ -1852,7 +2027,7 @@ declare namespace Components {
              *         { "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "statistical_method": "sum", "unit": "kWh", "color": "primary", "precision": 2 },
              *         ...
              *       ],
-             *       "intervals": ["PT15M", "PT1H", "P1D", "P1M"],
+             *       "intervals": ["PT15M", "PT1H", "P1D", "P1M", "P1Y"],
              *       "data_range": { "from": "2024-01-01T00:00:00Z", "to": "2026-05-01T00:00:00Z" }
              *     }
              *   Each type option carries its own `statistical_method`, which describes the method already applied to that type's data and dictates the chart shape: `sum` is rendered as a bar chart; `min`, `average`, and `max` are rendered as a line chart. A single visualization can therefore mix bar-shaped types with line-shaped types. Defaults to `sum` when omitted.
@@ -2729,7 +2904,7 @@ declare namespace Components {
          *         { "id": "ht", "label": { "en": "High tariff" }, "aggregation_group": "consumption", "statistical_method": "sum", "unit": "kWh", "color": "primary", "precision": 2 },
          *         ...
          *       ],
-         *       "intervals": ["PT15M", "PT1H", "P1D", "P1M"],
+         *       "intervals": ["PT15M", "PT1H", "P1D", "P1M", "P1Y"],
          *       "data_range": { "from": "2024-01-01T00:00:00Z", "to": "2026-05-01T00:00:00Z" }
          *     }
          *   Each type option carries its own `statistical_method`, which describes the method already applied to that type's data and dictates the chart shape: `sum` is rendered as a bar chart; `min`, `average`, and `max` are rendered as a line chart. A single visualization can therefore mix bar-shaped types with line-shaped types. Defaults to `sum` when omitted.
@@ -2917,7 +3092,7 @@ declare namespace Components {
             /**
              * App-level option declarations (with sensitivity) of this version
              */
-            options?: /* Options for the component configuration */ Options[];
+            options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Options[];
             /**
              * Flag to indicate if the app is in beta.
              */
@@ -3027,6 +3202,7 @@ declare namespace Paths {
             sourceVersion: Parameters.SourceVersion;
             targetVersion: Parameters.TargetVersion;
         }
+        export type RequestBody = Components.RequestBodies.CloneVersionRequest;
         namespace Responses {
             export interface $201 {
                 app_id?: string;
@@ -3610,7 +3786,7 @@ declare namespace Paths {
         }
         namespace Responses {
             export interface $200 {
-                options?: /* Options for the component configuration */ Components.Schemas.Options[];
+                options?: /* An option declaration — a setting the installing org fills in. Declared at app level. */ Components.Schemas.Options[];
             }
             export interface $403 {
             }
@@ -3916,7 +4092,7 @@ interface OperationMethods {
    */
   'cloneVersion'(
     parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
-    data?: any,
+    data?: Paths.CloneVersion.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CloneVersion.Responses.$201>
   /**
@@ -4309,7 +4485,7 @@ interface PathsDictionary {
      */
     'post'(
       parameters?: Parameters<Paths.CloneVersion.PathParameters> | null,
-      data?: any,
+      data?: Paths.CloneVersion.RequestBody,
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.CloneVersion.Responses.$201>
   }
@@ -4496,6 +4672,10 @@ type ExternalProductCatalogComponent = Components.Schemas.ExternalProductCatalog
 type ExternalProductCatalogConfig = Components.Schemas.ExternalProductCatalogConfig;
 type ExternalProductCatalogHookProductRecommendations = Components.Schemas.ExternalProductCatalogHookProductRecommendations;
 type ExternalProductCatalogHookProducts = Components.Schemas.ExternalProductCatalogHookProducts;
+type ExternalValuesComponent = Components.Schemas.ExternalValuesComponent;
+type ExternalValuesConfig = Components.Schemas.ExternalValuesConfig;
+type ExternalValuesHook = Components.Schemas.ExternalValuesHook;
+type ExternalValuesResult = Components.Schemas.ExternalValuesResult;
 type FunctionDefinition = Components.Schemas.FunctionDefinition;
 type FunctionRefCustomActionConfig = Components.Schemas.FunctionRefCustomActionConfig;
 type Grants = Components.Schemas.Grants;
@@ -4539,4 +4719,4 @@ type S3Reference = Components.Schemas.S3Reference;
 type TextArg = Components.Schemas.TextArg;
 type TranslatedString = Components.Schemas.TranslatedString;
 
-export { type Options 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 FunctionDefinition as N, type OperationMethods as O, Paths as P, type FunctionRefCustomActionConfig as Q, type Grants as R, type Installation as S, type InternalReview as T, type JourneyBlockComponent as U, type JourneyBlockComponentArgs as V, type JourneyBlockConfig as W, type NotificationConfig as X, type NotificationEvent as Y, type ObjectField as Z, type Option as _, Components as a, type OptionsRef as a0, type OverrideDevMode as a1, type PortalBlockComponent as a2, type PortalBlockConfig as a3, type PortalBlockSurfaceConfig as a4, type PortalExtensionAuthBlock as a5, type PortalExtensionComponent as a6, type PortalExtensionConfig as a7, type PortalExtensionHookChangeEmail as a8, type PortalExtensionHookChangePassword as a9, type PortalExtensionHookConsumptionDataRetrieval as aa, type PortalExtensionHookContractIdentification as ab, type PortalExtensionHookCostDataRetrieval as ac, type PortalExtensionHookDataExport as ad, type PortalExtensionHookDeleteAccount as ae, type PortalExtensionHookMeterReadingPlausibilityCheck as af, type PortalExtensionHookPriceDataRetrieval as ag, type PortalExtensionHookRegistrationIdentifiersCheck as ah, type PortalExtensionHookVisualizationMetadata as ai, type PortalExtensionSeamlessLink as aj, type PortalExtensionSecureProxy as ak, type Pricing as al, type PublicConfiguration as am, type RawEvents as an, type Review as ao, type Role as ap, type S3Reference as aq, type TextArg as ar, type TranslatedString as as, 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 };
+export { type NotificationConfig 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 ExternalValuesComponent as N, type OperationMethods as O, Paths as P, type ExternalValuesConfig as Q, type ExternalValuesHook as R, type ExternalValuesResult as S, type FunctionDefinition as T, type FunctionRefCustomActionConfig as U, type Grants as V, type Installation as W, type InternalReview as X, type JourneyBlockComponent as Y, type JourneyBlockComponentArgs as Z, type JourneyBlockConfig as _, Components as a, type NotificationEvent as a0, type ObjectField as a1, type Option as a2, type Options as a3, type OptionsRef as a4, type OverrideDevMode as a5, type PortalBlockComponent as a6, type PortalBlockConfig as a7, type PortalBlockSurfaceConfig as a8, type PortalExtensionAuthBlock as a9, type PortalExtensionComponent as aa, type PortalExtensionConfig as ab, type PortalExtensionHookChangeEmail as ac, type PortalExtensionHookChangePassword as ad, type PortalExtensionHookConsumptionDataRetrieval as ae, type PortalExtensionHookContractIdentification as af, type PortalExtensionHookCostDataRetrieval as ag, type PortalExtensionHookDataExport as ah, type PortalExtensionHookDeleteAccount as ai, type PortalExtensionHookMeterReadingPlausibilityCheck as aj, type PortalExtensionHookPriceDataRetrieval as ak, type PortalExtensionHookRegistrationIdentifiersCheck as al, type PortalExtensionHookVisualizationMetadata as am, type PortalExtensionSeamlessLink as an, type PortalExtensionSecureProxy as ao, type Pricing as ap, type PublicConfiguration as aq, type RawEvents as ar, type Review as as, type Role as at, type S3Reference as au, type TextArg as av, type TranslatedString as aw, 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 };