@epilot/journey-client 0.5.3 → 0.6.0-alpha.0

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={223(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var o=n(t(466));r.default=o.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.0","info":{"title":"","version":""},"paths":{"/v1/journey/organization/{id}":{"get":{"operationId":"getJourneysByOrgId","parameters":[{"name":"id","in":"path","required":true},{"name":"hydrate","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration/{id}":{"get":{"operationId":"getJourney","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false},{"name":"source","in":"query","required":false},{"name":"orgId","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/products/{id}":{"get":{"operationId":"getJourneyProducts","parameters":[{"name":"id","in":"path","required":true},{"name":"source","in":"query","required":false},{"name":"postal_code","in":"query","required":false},{"name":"city","in":"query","required":false},{"name":"street","in":"query","required":false},{"name":"street_number","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration":{"post":{"operationId":"createJourney","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/configuration/search":{"post":{"operationId":"searchJourneys","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/document:generate":{"post":{"operationId":"generateDocument","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/journey/configuration":{"post":{"operationId":"createJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v2/journey/configuration/{id}":{"get":{"operationId":"getJourneyV2","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourneyV2","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/{id}/settings":{"get":{"operationId":"getSettingsForJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/button-options":{"get":{"operationId":"getButtonOptions","parameters":[{"in":"query","name":"fileId","required":true}],"responses":{}}}},"components":{},"servers":[{"url":"https://journey-config.sls.epilot.io"}]}')}},r={},t=function t(n){var o=r[n];if(void 0!==o)return o.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(223),n=exports;for(var o in t)n[o]=t[o];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={223(e,r,n){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var o=t(n(466));r.default=o.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.0","info":{"title":"","version":""},"paths":{"/v1/journey/organization/{id}":{"get":{"operationId":"getJourneysByOrgId","parameters":[{"name":"id","in":"path","required":true},{"name":"hydrate","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration/{id}":{"get":{"operationId":"getJourney","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false},{"name":"source","in":"query","required":false},{"name":"orgId","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/configuration/{id}/environment":{"get":{"operationId":"getJourneyEnvironment","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/products/{id}":{"get":{"operationId":"getJourneyProducts","parameters":[{"name":"id","in":"path","required":true},{"name":"source","in":"query","required":false},{"name":"postal_code","in":"query","required":false},{"name":"city","in":"query","required":false},{"name":"street","in":"query","required":false},{"name":"street_number","in":"query","required":false}],"responses":{}}},"/v1/journey/configuration":{"post":{"operationId":"createJourney","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourney","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/configuration/search":{"post":{"operationId":"searchJourneys","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v1/journey/document:generate":{"post":{"operationId":"generateDocument","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/journey/configuration":{"post":{"operationId":"createJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[{"name":"skipAutomation","in":"query","required":false}],"responses":{}},"put":{"operationId":"updateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}},"patch":{"operationId":"patchUpdateJourneyV2","requestBody":{"content":{"application/json":{}}},"parameters":[],"responses":{}}},"/v2/journey/configuration/{id}":{"get":{"operationId":"getJourneyV2","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query","required":false}],"responses":{}},"delete":{"operationId":"removeJourneyV2","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/{id}/settings":{"get":{"operationId":"getSettingsForJourney","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/journey/button-options":{"get":{"operationId":"getButtonOptions","parameters":[{"in":"query","name":"fileId","required":true}],"responses":{}}}},"components":{},"servers":[{"url":"https://journey-config.sls.epilot.io"}]}')}},r={},n=function n(t){var o=r[t];if(void 0!==o)return o.exports;var a=r[t]={exports:{}};return e[t].call(a.exports,a,a.exports,n),a.exports}(223),t=exports;for(var o in n)t[o]=n[o];n.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})();

package/dist/openapi.d.ts

@@ -25,6 +25,16 @@ declare namespace Components {
              */
             label?: string;
         }
+        export interface EnvironmentMap {
+            fallbackLanguage?: string;
+            options: EnvironmentMapEntry[];
+        }
+        export interface EnvironmentMapEntry {
+            key: string;
+            value: string | {
+                [name: string]: string;
+            };
+        }
         export interface GenerateDocumentRequest {
             /**
              * Entity id for the template being used
@@ -38,6 +48,10 @@ declare namespace Components {
             context_data: {
                 additionalProperties?: string;
             };
+            /**
+             * Entity id used to resolve entity and relational template variables
+             */
+            context_entity_id?: string; // uuid
             /**
              * Language code for the document
              * example:
@@ -150,6 +164,7 @@ declare namespace Components {
                 showStepSubtitle?: boolean | null;
                 showStepper?: boolean | null;
                 showStepperLabels?: boolean | null;
+                stepperType?: "numbers" | "progress bar";
                 hideNextButton?: boolean | null;
                 name: string;
                 stepId?: string;
@@ -262,6 +277,10 @@ declare namespace Components {
                  * If type is not text, we can instruct the journey to fetch the entity id we receive as value
                  */
                 shouldLoadEntity?: boolean;
+                /**
+                 * Human-readable note describing the parameter's purpose. Free text; may contain newlines.
+                 */
+                description?: string | null;
             }[];
             /**
              * Journey Template
@@ -280,7 +299,11 @@ declare namespace Components {
             settings?: {
                 embedOptions?: {
                     mode?: "full-screen" | "inline";
-                    lang?: "de" | "en" | "fr";
+                    /**
+                     * example:
+                     * de
+                     */
+                    lang?: string;
                     width?: string;
                     topBar?: boolean;
                     scrollToTop?: boolean;
@@ -295,9 +318,13 @@ declare namespace Components {
                  */
                 canary?: boolean;
                 designId: string;
-                templateId?: string;
+                templateId?: string | null;
                 entityId?: string | null;
                 mappingsAutomationId?: string;
+                /**
+                 * When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
+                 */
+                newMappings?: boolean;
                 targetedCustomer?: string;
                 description?: string | null;
                 organizationSettings?: {
@@ -341,12 +368,21 @@ declare namespace Components {
                  */
                 enableDarkMode?: boolean;
                 accessMode?: "PUBLIC" | "PRIVATE";
+                /**
+                 * Steps after this step require an authenticated session (auth gate)
+                 */
+                authGate?: {
+                    /**
+                     * The step containing the Login & Registration block
+                     */
+                    stepId: string;
+                };
                 isPublished?: boolean;
                 status?: string;
                 isActive?: boolean;
                 savingProgress?: {
-                    savingMode?: "auto" | "local" | "remote" | "none";
-                    supportedVersion?: number;
+                    mode?: "auto" | "local" | "remote" | "none";
+                    supportedRevision?: number;
                 };
                 /**
                  * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
@@ -355,14 +391,22 @@ declare namespace Components {
             };
             validationRules?: /**
              * References to validation rules organized by blocks and fields.
-             * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
+             * Maps block IDs to either one or more ordered rule IDs (for block-level rules)
+             * or rule references (for field-level rules).
              *
              * example:
              * {
              *   "block1": "rule123",
-             *   "block2": {
-             *     "field1": "rule456",
-             *     "field2": "rule789"
+             *   "block2": [
+             *     "rule456",
+             *     "rule789"
+             *   ],
+             *   "block3": {
+             *     "field1": "rule101",
+             *     "field2": [
+             *       "rule102",
+             *       "rule103"
+             *     ]
              *   }
              * }
              */
@@ -386,6 +430,18 @@ declare namespace Components {
                 [name: string]: any;
             };
         }
+        /**
+         * Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
+         *
+         */
+        export interface JourneyActivationGuarantee {
+            settings: {
+                /**
+                 * Whether the journey is active (accessible to end customers)
+                 */
+                isActive: boolean;
+            };
+        }
         export interface JourneyAuditInfo {
             createdAt: string;
             lastModifiedAt: string;
@@ -406,6 +462,7 @@ declare namespace Components {
                 showStepSubtitle?: boolean | null;
                 showStepper?: boolean | null;
                 showStepperLabels?: boolean | null;
+                stepperType?: "numbers" | "progress bar";
                 hideNextButton?: boolean | null;
                 name: string;
                 stepId?: string;
@@ -518,6 +575,10 @@ declare namespace Components {
                  * If type is not text, we can instruct the journey to fetch the entity id we receive as value
                  */
                 shouldLoadEntity?: boolean;
+                /**
+                 * Human-readable note describing the parameter's purpose. Free text; may contain newlines.
+                 */
+                description?: string | null;
             }[];
             /**
              * Journey Template
@@ -536,7 +597,11 @@ declare namespace Components {
             settings?: {
                 embedOptions?: {
                     mode?: "full-screen" | "inline";
-                    lang?: "de" | "en" | "fr";
+                    /**
+                     * example:
+                     * de
+                     */
+                    lang?: string;
                     width?: string;
                     topBar?: boolean;
                     scrollToTop?: boolean;
@@ -551,9 +616,13 @@ declare namespace Components {
                  */
                 canary?: boolean;
                 designId: string;
-                templateId?: string;
+                templateId?: string | null;
                 entityId?: string | null;
                 mappingsAutomationId?: string;
+                /**
+                 * When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
+                 */
+                newMappings?: boolean;
                 targetedCustomer?: string;
                 description?: string | null;
                 organizationSettings?: {
@@ -597,12 +666,21 @@ declare namespace Components {
                  */
                 enableDarkMode?: boolean;
                 accessMode?: "PUBLIC" | "PRIVATE";
+                /**
+                 * Steps after this step require an authenticated session (auth gate)
+                 */
+                authGate?: {
+                    /**
+                     * The step containing the Login & Registration block
+                     */
+                    stepId: string;
+                };
                 isPublished?: boolean;
                 status?: string;
                 isActive?: boolean;
                 savingProgress?: {
-                    savingMode?: "auto" | "local" | "remote" | "none";
-                    supportedVersion?: number;
+                    mode?: "auto" | "local" | "remote" | "none";
+                    supportedRevision?: number;
                 };
                 /**
                  * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
@@ -611,14 +689,22 @@ declare namespace Components {
             };
             validationRules?: /**
              * References to validation rules organized by blocks and fields.
-             * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
+             * Maps block IDs to either one or more ordered rule IDs (for block-level rules)
+             * or rule references (for field-level rules).
              *
              * example:
              * {
              *   "block1": "rule123",
-             *   "block2": {
-             *     "field1": "rule456",
-             *     "field2": "rule789"
+             *   "block2": [
+             *     "rule456",
+             *     "rule789"
+             *   ],
+             *   "block3": {
+             *     "field1": "rule101",
+             *     "field2": [
+             *       "rule102",
+             *       "rule103"
+             *     ]
              *   }
              * }
              */
@@ -645,6 +731,7 @@ declare namespace Components {
                 showStepSubtitle?: boolean | null;
                 showStepper?: boolean | null;
                 showStepperLabels?: boolean | null;
+                stepperType?: "numbers" | "progress bar";
                 hideNextButton?: boolean | null;
                 name: string;
                 stepId?: string;
@@ -757,6 +844,10 @@ declare namespace Components {
                  * If type is not text, we can instruct the journey to fetch the entity id we receive as value
                  */
                 shouldLoadEntity?: boolean;
+                /**
+                 * Human-readable note describing the parameter's purpose. Free text; may contain newlines.
+                 */
+                description?: string | null;
             }[];
             /**
              * Journey Template
@@ -775,7 +866,11 @@ declare namespace Components {
             settings?: {
                 embedOptions?: {
                     mode?: "full-screen" | "inline";
-                    lang?: "de" | "en" | "fr";
+                    /**
+                     * example:
+                     * de
+                     */
+                    lang?: string;
                     width?: string;
                     topBar?: boolean;
                     scrollToTop?: boolean;
@@ -788,7 +883,11 @@ declare namespace Components {
                 designId?: string;
                 entityId?: string | null;
                 mappingsAutomationId?: string;
-                templateId?: string;
+                /**
+                 * When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
+                 */
+                newMappings?: boolean;
+                templateId?: string | null;
                 targetedCustomer?: string;
                 description?: string | null;
                 publicToken?: string | null;
@@ -825,22 +924,47 @@ declare namespace Components {
                  */
                 thirdPartyCookies?: boolean;
                 accessMode?: "PUBLIC" | "PRIVATE";
+                /**
+                 * Steps after this step require an authenticated session (auth gate)
+                 */
+                authGate?: {
+                    /**
+                     * The step containing the Login & Registration block
+                     */
+                    stepId: string;
+                };
                 /**
                  * If true, the journey shows an icon to toggle dark mode
                  */
                 enableDarkMode?: boolean;
+                /**
+                 * If true, some journey input labels are in Austrian format
+                 */
+                useAustrianLabels?: boolean;
                 isActive?: boolean;
+                savingProgress?: {
+                    mode?: "auto" | "local" | "remote" | "none";
+                    supportedRevision?: number;
+                };
             };
             validationRules?: /**
              * References to validation rules organized by blocks and fields.
-             * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
+             * Maps block IDs to either one or more ordered rule IDs (for block-level rules)
+             * or rule references (for field-level rules).
              *
              * example:
              * {
              *   "block1": "rule123",
-             *   "block2": {
-             *     "field1": "rule456",
-             *     "field2": "rule789"
+             *   "block2": [
+             *     "rule456",
+             *     "rule789"
+             *   ],
+             *   "block3": {
+             *     "field1": "rule101",
+             *     "field2": [
+             *       "rule102",
+             *       "rule103"
+             *     ]
              *   }
              * }
              */
@@ -850,6 +974,17 @@ declare namespace Components {
              */
             _manifest?: string /* uuid */[];
         }
+        export interface JourneyEnvironmentResponse {
+            items: {
+                datasourceId: string;
+                type: "Text" | "Number" | "Boolean" | "Map";
+                value: string | number | boolean | EnvironmentMap;
+            }[];
+            errors: {
+                datasourceId: string;
+                code: "not_found" | "unsupported_type" | "not_set" | "invalid_value" | "incompatible_consumer";
+            }[];
+        }
         export interface JourneyFeatureFlags {
             featureFlags?: {
                 [name: string]: any;
@@ -957,17 +1092,22 @@ declare namespace Components {
         }
         /**
          * Field-level rule references within a block.
-         * Maps field names to rule IDs.
+         * Maps field names to one or more ordered rule IDs.
          *
          * example:
          * {
          *   "firstName": "rule123",
-         *   "lastName": "rule456",
-         *   "email": "rule789"
+         *   "lastName": [
+         *     "rule456",
+         *     "rule789"
+         *   ]
          * }
          */
         export interface RuleRef {
-            [name: string]: string;
+            [name: string]: string | [
+                string,
+                ...string[]
+            ];
         }
         export interface S3Reference {
             /**
@@ -1181,27 +1321,40 @@ declare namespace Components {
         }
         /**
          * References to validation rules organized by blocks and fields.
-         * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
+         * Maps block IDs to either one or more ordered rule IDs (for block-level rules)
+         * or rule references (for field-level rules).
          *
          * example:
          * {
          *   "block1": "rule123",
-         *   "block2": {
-         *     "field1": "rule456",
-         *     "field2": "rule789"
+         *   "block2": [
+         *     "rule456",
+         *     "rule789"
+         *   ],
+         *   "block3": {
+         *     "field1": "rule101",
+         *     "field2": [
+         *       "rule102",
+         *       "rule103"
+         *     ]
          *   }
          * }
          */
         export interface ValidationRuleRef {
-            [name: string]: string | /**
+            [name: string]: string | [
+                string,
+                ...string[]
+            ] | /**
              * Field-level rule references within a block.
-             * Maps field names to rule IDs.
+             * Maps field names to one or more ordered rule IDs.
              *
              * example:
              * {
              *   "firstName": "rule123",
-             *   "lastName": "rule456",
-             *   "email": "rule789"
+             *   "lastName": [
+             *     "rule456",
+             *     "rule789"
+             *   ]
              * }
              */
             RuleRef;
@@ -1326,7 +1479,309 @@ declare namespace Paths {
             orgId?: Parameters.OrgId;
         }
         namespace Responses {
-            export type $200 = Components.Schemas.Journey;
+            /**
+             * Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
+             *
+             */
+            export interface $200 {
+                [name: string]: any;
+                journeyId?: string;
+                organizationId: string;
+                brandId?: string;
+                name: string;
+                steps: {
+                    showStepName?: boolean | null;
+                    title?: string | null;
+                    subTitle?: string | null;
+                    showStepSubtitle?: boolean | null;
+                    showStepper?: boolean | null;
+                    showStepperLabels?: boolean | null;
+                    stepperType?: "numbers" | "progress bar";
+                    hideNextButton?: boolean | null;
+                    name: string;
+                    stepId?: string;
+                    schema: any;
+                    uischema: any;
+                    maxWidth?: "small" | "medium" | "large" | "extra large";
+                }[];
+                design?: {
+                    logoUrl?: string | null;
+                    theme?: {
+                        [name: string]: any;
+                    };
+                    designTokens?: {
+                        [key: string]: any;
+                    };
+                };
+                rules?: {
+                    type: "inject" | "injectWithKey";
+                    sourceType: "journey" | "step" | "block";
+                    source: string;
+                    target: string;
+                }[];
+                logics?: {
+                    autoGeneratedId?: string;
+                    conditions: string[];
+                    actions: string[];
+                }[];
+                logicsV4?: {
+                    [name: string]: {
+                        /**
+                         * Unique identifier for logic. Use uuidv7
+                         */
+                        id?: string; // uuid
+                        /**
+                         * If true, logic can't be manipulated by the configuring user
+                         */
+                        protected?: boolean;
+                        /**
+                         * Indicates which action to take in case logic evaluates to true
+                         */
+                        action?: string;
+                        /**
+                         * Indicates when the logic should be evaluated
+                         */
+                        triggeredOn?: string;
+                        conditions?: {
+                            /**
+                             * Operator to be applied between the fact value and the value
+                             */
+                            operator?: string;
+                            /**
+                             * If operator is a custom function, this needs to be provided
+                             */
+                            functionName?: string;
+                            fact?: {
+                                /**
+                                 * Unique identifier for a fact
+                                 */
+                                id?: string; // uuid
+                                /**
+                                 * Indicates reference type (block or context parameter)
+                                 */
+                                referenceType?: string;
+                                /**
+                                 * Id of the reference
+                                 */
+                                referenceId?: string;
+                                /**
+                                 * Path to a property. Used if only part of the value is needed
+                                 */
+                                path?: string;
+                                /**
+                                 * If path is a reference, indicates the intention of it
+                                 */
+                                meaning?: string;
+                            };
+                            value?: string | number | boolean | {
+                                [key: string]: any;
+                            } | any[];
+                            args?: {
+                                [key: string]: any;
+                            };
+                        }[][];
+                        /**
+                         * Logic specific settings. Will vary by type of logic
+                         */
+                        settings?: {
+                            [key: string]: any;
+                        };
+                    };
+                };
+                contextSchema?: {
+                    /**
+                     * Unique identifier for the context schema item
+                     */
+                    id?: string; // uuid
+                    /**
+                     * Type of the parameter. It could be either an entity slug, or a text
+                     */
+                    type: string;
+                    /**
+                     * Expected key to be received in the context
+                     */
+                    paramKey: string;
+                    /**
+                     * Indicates if a value is expected to be provided
+                     */
+                    isRequired?: boolean;
+                    /**
+                     * If type is not text, we can instruct the journey to fetch the entity id we receive as value
+                     */
+                    shouldLoadEntity?: boolean;
+                    /**
+                     * Human-readable note describing the parameter's purpose. Free text; may contain newlines.
+                     */
+                    description?: string | null;
+                }[];
+                /**
+                 * Journey Template
+                 * example:
+                 * Sales template (Premium)
+                 */
+                journey_type?: string;
+                /**
+                 * If true, journey is displayed in read-only mode
+                 */
+                protected?: boolean;
+                /**
+                 * Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*​/blocks/**).
+                 */
+                protectedEditable?: string[];
+                settings: {
+                    embedOptions?: {
+                        mode?: "full-screen" | "inline";
+                        /**
+                         * example:
+                         * de
+                         */
+                        lang?: string;
+                        width?: string;
+                        topBar?: boolean;
+                        scrollToTop?: boolean;
+                        button?: {
+                            text?: string | null;
+                            align?: "left" | "center" | "right";
+                        };
+                    };
+                    safeModeAutomation?: boolean;
+                    /**
+                     * DEPRECATED - This API will return hardcoded value of false. Please note that this field is internal to epilot and should not be used by external clients. If you wish to get the canary flag, please use the /v1/journey/{id}/settings API.
+                     */
+                    canary?: boolean;
+                    designId: string;
+                    templateId?: string | null;
+                    entityId?: string | null;
+                    mappingsAutomationId?: string;
+                    /**
+                     * When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
+                     */
+                    newMappings?: boolean;
+                    targetedCustomer?: string;
+                    description?: string | null;
+                    organizationSettings?: {
+                        [name: string]: boolean;
+                    } | null;
+                    publicToken?: string | null;
+                    runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
+                    filePurposes?: string[];
+                    entityTags?: string[];
+                    /**
+                     * @deprecated Use addressSuggestionsFileId instead
+                     */
+                    addressSuggestionsFileUrl?: string | null;
+                    addressSuggestionsFileId?: string | null;
+                    /**
+                     * Country code for address format (e.g. DE, AT, CH, LU)
+                     */
+                    addressSuggestionsCountryCode?: string | null;
+                    /**
+                     * Whether address auto-complete is enabled
+                     */
+                    addressSuggestionsEnableAutoComplete?: boolean;
+                    /**
+                     * Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
+                     */
+                    addressSuggestionsSource?: string[];
+                    /**
+                     * Whether free text input is allowed when auto-complete is on
+                     */
+                    addressSuggestionsEnableFreeText?: boolean;
+                    /**
+                     * This property is deprecated and will be removed in a future version
+                     */
+                    useNewDesign?: boolean;
+                    /**
+                     * If true, some journey input labels are in Austrian format
+                     */
+                    useAustrianLabels?: boolean;
+                    /**
+                     * If true, the journey shows an icon to toggle dark mode
+                     */
+                    enableDarkMode?: boolean;
+                    accessMode?: "PUBLIC" | "PRIVATE";
+                    /**
+                     * Steps after this step require an authenticated session (auth gate)
+                     */
+                    authGate?: {
+                        /**
+                         * The step containing the Login & Registration block
+                         */
+                        stepId: string;
+                    };
+                    isPublished?: boolean;
+                    status?: string;
+                    /**
+                     * Whether the journey is active (accessible to end customers)
+                     */
+                    isActive: boolean;
+                    savingProgress?: {
+                        mode?: "auto" | "local" | "remote" | "none";
+                        supportedRevision?: number;
+                    };
+                    /**
+                     * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
+                     */
+                    thirdPartyCookies?: boolean;
+                };
+                validationRules?: /**
+                 * References to validation rules organized by blocks and fields.
+                 * Maps block IDs to either one or more ordered rule IDs (for block-level rules)
+                 * or rule references (for field-level rules).
+                 *
+                 * example:
+                 * {
+                 *   "block1": "rule123",
+                 *   "block2": [
+                 *     "rule456",
+                 *     "rule789"
+                 *   ],
+                 *   "block3": {
+                 *     "field1": "rule101",
+                 *     "field2": [
+                 *       "rule102",
+                 *       "rule103"
+                 *     ]
+                 *   }
+                 * }
+                 */
+                Components.Schemas.ValidationRuleRef;
+                /**
+                 * Manifest/Blueprint ID used to create/update the entity
+                 */
+                _manifest?: string /* uuid */[];
+                createdBy?: string;
+                updatedBy?: string | null;
+                /**
+                 * If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
+                 */
+                __lastModifiedAt?: string | null;
+                createdAt: string;
+                lastModifiedAt: string;
+                deletedAt?: string;
+                version: number;
+                revisions: number;
+                featureFlags?: {
+                    [name: string]: any;
+                };
+            }
+        }
+    }
+    namespace GetJourneyEnvironment {
+        namespace Parameters {
+            export type Id = string; // uuid
+        }
+        export interface PathParameters {
+            id: Parameters.Id /* uuid */;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.JourneyEnvironmentResponse;
+            export interface $401 {
+            }
+            export interface $403 {
+            }
+            export interface $502 {
+            }
         }
     }
     namespace GetJourneyProducts {
@@ -1380,7 +1835,267 @@ declare namespace Paths {
             version?: Parameters.Version;
         }
         namespace Responses {
-            export type $200 = Components.Schemas.JourneyCreationRequestV2;
+            /**
+             * Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
+             *
+             */
+            export interface $200 {
+                journeyId?: string;
+                brandId?: string;
+                name: string;
+                steps: {
+                    showStepName?: boolean | null;
+                    title?: string | null;
+                    subTitle?: string | null;
+                    showStepSubtitle?: boolean | null;
+                    showStepper?: boolean | null;
+                    showStepperLabels?: boolean | null;
+                    stepperType?: "numbers" | "progress bar";
+                    hideNextButton?: boolean | null;
+                    name: string;
+                    stepId?: string;
+                    schema: any;
+                    uischema: any;
+                    maxWidth?: "small" | "medium" | "large" | "extra large";
+                }[];
+                design?: {
+                    logoUrl?: string | null;
+                    theme?: {
+                        [name: string]: any;
+                    };
+                    designTokens?: {
+                        [key: string]: any;
+                    };
+                };
+                rules?: {
+                    type: "inject" | "injectWithKey";
+                    sourceType: "journey" | "step" | "block";
+                    source: string;
+                    target: string;
+                }[];
+                logics?: {
+                    autoGeneratedId?: string;
+                    conditions: string[];
+                    actions: string[];
+                }[];
+                logicsV4?: {
+                    [name: string]: {
+                        /**
+                         * Unique identifier for logic. Use uuidv7
+                         */
+                        id?: string; // uuid
+                        /**
+                         * If true, logic can't be manipulated by the configuring user
+                         */
+                        protected?: boolean;
+                        /**
+                         * Indicates which action to take in case logic evaluates to true
+                         */
+                        action?: string;
+                        /**
+                         * Indicates when the logic should be evaluated
+                         */
+                        triggeredOn?: string;
+                        conditions?: {
+                            /**
+                             * Operator to be applied between the fact value and the value
+                             */
+                            operator?: string;
+                            /**
+                             * If operator is a custom function, this needs to be provided
+                             */
+                            functionName?: string;
+                            fact?: {
+                                /**
+                                 * Unique identifier for a fact
+                                 */
+                                id?: string; // uuid
+                                /**
+                                 * Indicates reference type (block or context parameter)
+                                 */
+                                referenceType?: string;
+                                /**
+                                 * Id of the reference
+                                 */
+                                referenceId?: string;
+                                /**
+                                 * Path to a property. Used if only part of the value is needed
+                                 */
+                                path?: string;
+                                /**
+                                 * If path is a reference, indicates the intention of it
+                                 */
+                                meaning?: string;
+                            };
+                            value?: string | number | boolean | {
+                                [key: string]: any;
+                            } | any[];
+                            args?: {
+                                [key: string]: any;
+                            };
+                        }[][];
+                        /**
+                         * Logic specific settings. Will vary by type of logic
+                         */
+                        settings?: {
+                            [key: string]: any;
+                        };
+                    };
+                };
+                contextSchema?: {
+                    /**
+                     * Unique identifier for the context schema item
+                     */
+                    id?: string; // uuid
+                    /**
+                     * Type of the parameter. It could be either an entity slug, or a text
+                     */
+                    type: string;
+                    /**
+                     * Expected key to be received in the context
+                     */
+                    paramKey: string;
+                    /**
+                     * Indicates if a value is expected to be provided
+                     */
+                    isRequired?: boolean;
+                    /**
+                     * If type is not text, we can instruct the journey to fetch the entity id we receive as value
+                     */
+                    shouldLoadEntity?: boolean;
+                    /**
+                     * Human-readable note describing the parameter's purpose. Free text; may contain newlines.
+                     */
+                    description?: string | null;
+                }[];
+                /**
+                 * Journey Template
+                 * example:
+                 * Sales template (Premium)
+                 */
+                journey_type?: string;
+                /**
+                 * If true, journey is displayed in read-only mode
+                 */
+                protected?: boolean;
+                /**
+                 * Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*​/blocks/**).
+                 */
+                protectedEditable?: string[];
+                settings: {
+                    embedOptions?: {
+                        mode?: "full-screen" | "inline";
+                        /**
+                         * example:
+                         * de
+                         */
+                        lang?: string;
+                        width?: string;
+                        topBar?: boolean;
+                        scrollToTop?: boolean;
+                        button?: {
+                            text?: string | null;
+                            align?: "left" | "center" | "right";
+                        };
+                    };
+                    safeModeAutomation?: boolean;
+                    designId?: string;
+                    entityId?: string | null;
+                    mappingsAutomationId?: string;
+                    /**
+                     * When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
+                     */
+                    newMappings?: boolean;
+                    templateId?: string | null;
+                    targetedCustomer?: string;
+                    description?: string | null;
+                    publicToken?: string | null;
+                    runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
+                    filePurposes?: string[];
+                    entityTags?: string[];
+                    /**
+                     * @deprecated Use addressSuggestionsFileId instead
+                     */
+                    addressSuggestionsFileUrl?: string | null;
+                    addressSuggestionsFileId?: string | null;
+                    /**
+                     * Country code for address format (e.g. DE, AT, CH, LU)
+                     */
+                    addressSuggestionsCountryCode?: string | null;
+                    /**
+                     * Whether address auto-complete is enabled
+                     */
+                    addressSuggestionsEnableAutoComplete?: boolean;
+                    /**
+                     * Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
+                     */
+                    addressSuggestionsSource?: string[];
+                    /**
+                     * Whether free text input is allowed when auto-complete is on
+                     */
+                    addressSuggestionsEnableFreeText?: boolean;
+                    /**
+                     * This property is deprecated and will be removed in a future version
+                     */
+                    useNewDesign?: boolean;
+                    /**
+                     * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
+                     */
+                    thirdPartyCookies?: boolean;
+                    accessMode?: "PUBLIC" | "PRIVATE";
+                    /**
+                     * Steps after this step require an authenticated session (auth gate)
+                     */
+                    authGate?: {
+                        /**
+                         * The step containing the Login & Registration block
+                         */
+                        stepId: string;
+                    };
+                    /**
+                     * If true, the journey shows an icon to toggle dark mode
+                     */
+                    enableDarkMode?: boolean;
+                    /**
+                     * If true, some journey input labels are in Austrian format
+                     */
+                    useAustrianLabels?: boolean;
+                    /**
+                     * Whether the journey is active (accessible to end customers)
+                     */
+                    isActive: boolean;
+                    savingProgress?: {
+                        mode?: "auto" | "local" | "remote" | "none";
+                        supportedRevision?: number;
+                    };
+                };
+                validationRules?: /**
+                 * References to validation rules organized by blocks and fields.
+                 * Maps block IDs to either one or more ordered rule IDs (for block-level rules)
+                 * or rule references (for field-level rules).
+                 *
+                 * example:
+                 * {
+                 *   "block1": "rule123",
+                 *   "block2": [
+                 *     "rule456",
+                 *     "rule789"
+                 *   ],
+                 *   "block3": {
+                 *     "field1": "rule101",
+                 *     "field2": [
+                 *       "rule102",
+                 *       "rule103"
+                 *     ]
+                 *   }
+                 * }
+                 */
+                Components.Schemas.ValidationRuleRef;
+                /**
+                 * Manifest/Blueprint ID used to create/update the entity
+                 */
+                _manifest?: string /* uuid */[];
+            }
         }
     }
     namespace GetJourneysByOrgId {
@@ -1588,6 +2303,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<any>
+  /**
+   * getJourneyEnvironment - getJourneyEnvironment
+   * 
+   * Resolve the environment variables referenced by this journey. Only browser-safe value types are returned.
+   */
+  'getJourneyEnvironment'(
+    parameters?: Parameters<Paths.GetJourneyEnvironment.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetJourneyEnvironment.Responses.$200>
   /**
    * getJourneyProducts - getJourneyProducts
    * 
@@ -1766,6 +2491,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<any>
   }
+  ['/v1/journey/configuration/{id}/environment']: {
+    /**
+     * getJourneyEnvironment - getJourneyEnvironment
+     * 
+     * Resolve the environment variables referenced by this journey. Only browser-safe value types are returned.
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetJourneyEnvironment.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetJourneyEnvironment.Responses.$200>
+  }
   ['/v1/journey/products/{id}']: {
     /**
      * getJourneyProducts - getJourneyProducts
@@ -1929,14 +2666,18 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 
 export type ButtonOption = Components.Schemas.ButtonOption;
+export type EnvironmentMap = Components.Schemas.EnvironmentMap;
+export type EnvironmentMapEntry = Components.Schemas.EnvironmentMapEntry;
 export type GenerateDocumentRequest = Components.Schemas.GenerateDocumentRequest;
 export type GenerateDocumentResponse = Components.Schemas.GenerateDocumentResponse;
 export type GetJourneysResponse = Components.Schemas.GetJourneysResponse;
 export type GetSettingsForJourney = Components.Schemas.GetSettingsForJourney;
 export type Journey = Components.Schemas.Journey;
+export type JourneyActivationGuarantee = Components.Schemas.JourneyActivationGuarantee;
 export type JourneyAuditInfo = Components.Schemas.JourneyAuditInfo;
 export type JourneyCreationRequest = Components.Schemas.JourneyCreationRequest;
 export type JourneyCreationRequestV2 = Components.Schemas.JourneyCreationRequestV2;
+export type JourneyEnvironmentResponse = Components.Schemas.JourneyEnvironmentResponse;
 export type JourneyFeatureFlags = Components.Schemas.JourneyFeatureFlags;
 export type JourneyProductsResponse = Components.Schemas.JourneyProductsResponse;
 export type JourneyResponse = Components.Schemas.JourneyResponse;

package/package.json

@@ -1,9 +1,19 @@
 {
   "name": "@epilot/journey-client",
-  "version": "0.5.3",
+  "version": "0.6.0-alpha.0",
   "description": "API Client for epilot Journey API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "vitest",
+    "typescript": "tsc",
+    "bundle-definition": "webpack",
+    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/journey-config.yaml",
+    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
+    "build": "npm run openapi && npm run typegen && npm run typescript && npm run bundle-definition",
+    "eslint": "../node_modules/.bin/eslint -c ../.eslintrc.yml",
+    "prepublishOnly": "npm run build"
+  },
   "files": [
     "*.js",
     "*.d.ts",
@@ -47,14 +57,5 @@
     "vitest": "^1.6.0",
     "webpack": "^5.91.0",
     "webpack-cli": "^5.1.4"
-  },
-  "scripts": {
-    "test": "vitest",
-    "typescript": "tsc",
-    "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/journey-config.yaml",
-    "typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
-    "build": "npm run openapi && npm run typegen && npm run typescript && npm run bundle-definition",
-    "eslint": "../node_modules/.bin/eslint -c ../.eslintrc.yml"
   }
-}
+}