@epilot/sdk 2.20.78 → 2.20.79

package/dist/{journey.d-CMtM6U3Y.d.cts → journey.d-5GpTnSld.d.cts}

@@ -198,7 +198,17 @@ declare namespace Components {
              * true
              */
             thirdPartyCookies?: boolean;
+            /**
+             * Offline journeys (ER-5432): whether the published revision has settings.offline.enabled. Absent when the setting was never set.
+             * example:
+             * true
+             */
+            offline?: boolean;
         }
+        /**
+         * What the journey's Handlebars templates need from the organization, derived from the served configuration only. Present when the journey contains templates and templating is enabled for the organization. Read-only: like `featureFlags`, it is dropped from any write, so a client that sends the configuration back never stores it.
+         *
+         */
         export interface Journey {
             [name: string]: any;
             journeyId?: string;
@@ -447,7 +457,28 @@ declare namespace Components {
                      *
                      */
                     modernProducts?: boolean;
+                    /**
+                     * Opt this launcher journey into the modern Journey Launcher (picker, card and hero shells). Launcher journeys only. Effective when true OR the organization flag `journey-modern-launcher` is on.
+                     *
+                     */
+                    modernLauncher?: boolean;
                 };
+                /**
+                 * Offline journeys (ER-5432). Revision-owned like every other setting: effective on publish. The runtime prepares an offline pack for this journey only when the organization flag `journey-offline` is on AND `enabled` is true.
+                 *
+                 */
+                offline?: {
+                    /**
+                     * Prepare this journey for offline use on devices that open it online first.
+                     */
+                    enabled: boolean;
+                    /**
+                     * How long a prepared pack stays fresh before the next online open refreshes it. Default 24.
+                     * example:
+                     * 24
+                     */
+                    packTtlHours?: number;
+                } | null;
             };
             validationRules?: /**
              * References to validation rules organized by blocks and fields.
@@ -475,17 +506,6 @@ declare namespace Components {
              * Manifest/Blueprint ID used to create/update the entity
              */
             _manifest?: string /* uuid */[];
-            /**
-             * Blueprint field-locking contract (server-managed). Carries the
-             * author plane (locks, default level) and the org plane (server-derived
-             * overlay). Public writes never persist client-supplied values — the
-             * stored contract is authoritative; it is written only by the
-             * Blueprints install pipeline.
-             *
-             */
-            blueprint_customization?: {
-                [name: string]: any;
-            };
             createdBy?: string;
             updatedBy?: string | null;
             /**
@@ -508,6 +528,7 @@ declare namespace Components {
             featureFlags?: {
                 [name: string]: any;
             };
+            templating?: JourneyTemplating;
         }
         /**
          * Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
@@ -784,7 +805,28 @@ declare namespace Components {
                      *
                      */
                     modernProducts?: boolean;
+                    /**
+                     * Opt this launcher journey into the modern Journey Launcher (picker, card and hero shells). Launcher journeys only. Effective when true OR the organization flag `journey-modern-launcher` is on.
+                     *
+                     */
+                    modernLauncher?: boolean;
                 };
+                /**
+                 * Offline journeys (ER-5432). Revision-owned like every other setting: effective on publish. The runtime prepares an offline pack for this journey only when the organization flag `journey-offline` is on AND `enabled` is true.
+                 *
+                 */
+                offline?: {
+                    /**
+                     * Prepare this journey for offline use on devices that open it online first.
+                     */
+                    enabled: boolean;
+                    /**
+                     * How long a prepared pack stays fresh before the next online open refreshes it. Default 24.
+                     * example:
+                     * 24
+                     */
+                    packTtlHours?: number;
+                } | null;
             };
             validationRules?: /**
              * References to validation rules organized by blocks and fields.
@@ -812,17 +854,6 @@ declare namespace Components {
              * Manifest/Blueprint ID used to create/update the entity
              */
             _manifest?: string /* uuid */[];
-            /**
-             * Blueprint field-locking contract (server-managed). Carries the
-             * author plane (locks, default level) and the org plane (server-derived
-             * overlay). Public writes never persist client-supplied values — the
-             * stored contract is authoritative; it is written only by the
-             * Blueprints install pipeline.
-             *
-             */
-            blueprint_customization?: {
-                [name: string]: any;
-            };
             createdBy?: string;
             updatedBy?: string | null;
             /**
@@ -1067,7 +1098,28 @@ declare namespace Components {
                      *
                      */
                     modernProducts?: boolean;
+                    /**
+                     * Opt this launcher journey into the modern Journey Launcher (picker, card and hero shells). Launcher journeys only. Effective when true OR the organization flag `journey-modern-launcher` is on.
+                     *
+                     */
+                    modernLauncher?: boolean;
                 };
+                /**
+                 * Offline journeys (ER-5432). Revision-owned like every other setting: effective on publish. The runtime prepares an offline pack for this journey only when the organization flag `journey-offline` is on AND `enabled` is true.
+                 *
+                 */
+                offline?: {
+                    /**
+                     * Prepare this journey for offline use on devices that open it online first.
+                     */
+                    enabled: boolean;
+                    /**
+                     * How long a prepared pack stays fresh before the next online open refreshes it. Default 24.
+                     * example:
+                     * 24
+                     */
+                    packTtlHours?: number;
+                } | null;
             };
             validationRules?: /**
              * References to validation rules organized by blocks and fields.
@@ -1095,17 +1147,6 @@ declare namespace Components {
              * Manifest/Blueprint ID used to create/update the entity
              */
             _manifest?: string /* uuid */[];
-            /**
-             * Blueprint field-locking contract (server-managed). Carries the
-             * author plane (locks, default level) and the org plane (server-derived
-             * overlay). Public writes never persist client-supplied values — the
-             * stored contract is authoritative; it is written only by the
-             * Blueprints install pipeline.
-             *
-             */
-            blueprint_customization?: {
-                [name: string]: any;
-            };
         }
         export interface JourneyEnvironmentResponse {
             items: {
@@ -1321,7 +1362,11 @@ declare namespace Components {
             published_by?: string;
         }
         export interface JourneyResponse {
-            createdJourney?: Journey;
+            createdJourney?: /**
+             * What the journey's Handlebars templates need from the organization, derived from the served configuration only. Present when the journey contains templates and templating is enabled for the organization. Read-only: like `featureFlags`, it is dropped from any write, so a client that sends the configuration back never stores it.
+             *
+             */
+            Journey;
         }
         export interface JourneyRevision {
             /**
@@ -1611,7 +1656,28 @@ declare namespace Components {
                          *
                          */
                         modernProducts?: boolean;
+                        /**
+                         * Opt this launcher journey into the modern Journey Launcher (picker, card and hero shells). Launcher journeys only. Effective when true OR the organization flag `journey-modern-launcher` is on.
+                         *
+                         */
+                        modernLauncher?: boolean;
                     };
+                    /**
+                     * Offline journeys (ER-5432). Revision-owned like every other setting: effective on publish. The runtime prepares an offline pack for this journey only when the organization flag `journey-offline` is on AND `enabled` is true.
+                     *
+                     */
+                    offline?: {
+                        /**
+                         * Prepare this journey for offline use on devices that open it online first.
+                         */
+                        enabled: boolean;
+                        /**
+                         * How long a prepared pack stays fresh before the next online open refreshes it. Default 24.
+                         * example:
+                         * 24
+                         */
+                        packTtlHours?: number;
+                    } | null;
                 };
                 validationRules?: /**
                  * References to validation rules organized by blocks and fields.
@@ -1639,17 +1705,6 @@ declare namespace Components {
                  * Manifest/Blueprint ID used to create/update the entity
                  */
                 _manifest?: string /* uuid */[];
-                /**
-                 * Blueprint field-locking contract (server-managed). Carries the
-                 * author plane (locks, default level) and the org plane (server-derived
-                 * overlay). Public writes never persist client-supplied values — the
-                 * stored contract is authoritative; it is written only by the
-                 * Blueprints install pipeline.
-                 *
-                 */
-                blueprint_customization?: {
-                    [name: string]: any;
-                };
                 createdBy?: string;
                 updatedBy?: string | null;
                 /**
@@ -1672,6 +1727,7 @@ declare namespace Components {
                 featureFlags?: {
                     [name: string]: any;
                 };
+                templating?: JourneyTemplating;
             };
         }
         export interface JourneyRevisionConflict {
@@ -1942,7 +1998,28 @@ declare namespace Components {
                      *
                      */
                     modernProducts?: boolean;
+                    /**
+                     * Opt this launcher journey into the modern Journey Launcher (picker, card and hero shells). Launcher journeys only. Effective when true OR the organization flag `journey-modern-launcher` is on.
+                     *
+                     */
+                    modernLauncher?: boolean;
                 };
+                /**
+                 * Offline journeys (ER-5432). Revision-owned like every other setting: effective on publish. The runtime prepares an offline pack for this journey only when the organization flag `journey-offline` is on AND `enabled` is true.
+                 *
+                 */
+                offline?: {
+                    /**
+                     * Prepare this journey for offline use on devices that open it online first.
+                     */
+                    enabled: boolean;
+                    /**
+                     * How long a prepared pack stays fresh before the next online open refreshes it. Default 24.
+                     * example:
+                     * 24
+                     */
+                    packTtlHours?: number;
+                } | null;
             };
             validationRules?: /**
              * References to validation rules organized by blocks and fields.
@@ -1970,17 +2047,6 @@ declare namespace Components {
              * Manifest/Blueprint ID used to create/update the entity
              */
             _manifest?: string /* uuid */[];
-            /**
-             * Blueprint field-locking contract (server-managed). Carries the
-             * author plane (locks, default level) and the org plane (server-derived
-             * overlay). Public writes never persist client-supplied values — the
-             * stored contract is authoritative; it is written only by the
-             * Blueprints install pipeline.
-             *
-             */
-            blueprint_customization?: {
-                [name: string]: any;
-            };
             createdBy?: string;
             updatedBy?: string | null;
             /**
@@ -2064,6 +2130,60 @@ declare namespace Components {
              */
             revision_id?: string;
         }
+        export interface JourneyTemplateVariablesResponse {
+            /**
+             * Custom Variables a template can expand as `{{key}}`
+             */
+            customVariables: {
+                key: string;
+                name: string;
+            }[];
+            /**
+             * Environment variables a template can read as `{{env.key}}`; a Link as `{{env.key.url}}` and `{{env.key.label}}`
+             */
+            environment: {
+                key: string;
+                type: "String" | "Text" | "Number" | "Boolean" | "Link";
+                description?: string;
+                /**
+                 * The environment group the variable belongs to, when it has one
+                 */
+                group?: string;
+            }[];
+        }
+        export interface JourneyTemplating {
+            /**
+             * Custom Variables the journey's templates reference, expanded transitively
+             */
+            customVariables: {
+                key: string;
+                template: string;
+            }[];
+            /**
+             * Browser-safe environment values the templates read, keyed by variable key; scalars, or a Link's fields
+             */
+            env: {
+                [name: string]: string | number | boolean | /* A Link variable; label and description are a string or per-language strings, resolved by the runtime */ JourneyTemplatingLink;
+            };
+        }
+        /**
+         * What the journey's Handlebars templates need from the organization, derived from the served configuration only. Present when the journey contains templates and templating is enabled for the organization. Read-only: like `featureFlags`, it is dropped from any write, so a client that sends the configuration back never stores it.
+         *
+         */
+        export interface JourneyTemplatingContext {
+            templating?: JourneyTemplating;
+        }
+        /**
+         * A Link variable; label and description are a string or per-language strings, resolved by the runtime
+         */
+        export interface JourneyTemplatingLink {
+            url: string;
+            label: JourneyTemplatingTranslatable;
+            description?: JourneyTemplatingTranslatable;
+        }
+        export type JourneyTemplatingTranslatable = string | {
+            [name: string]: string;
+        };
         export interface JourneyValidationError {
             /**
              * Error type identifier
@@ -2472,7 +2592,11 @@ declare namespace Paths {
         }
         export type RequestBody = Components.Schemas.JourneyCreationRequest;
         namespace Responses {
-            export type $201 = Components.Schemas.Journey;
+            export type $201 = /**
+             * What the journey's Handlebars templates need from the organization, derived from the served configuration only. Present when the journey contains templates and templating is enabled for the organization. Read-only: like `featureFlags`, it is dropped from any write, so a client that sends the configuration back never stores it.
+             *
+             */
+            Components.Schemas.Journey;
             export type $400 = Components.Schemas.JourneyValidationError;
         }
     }
@@ -2868,7 +2992,28 @@ declare namespace Paths {
                          *
                          */
                         modernProducts?: boolean;
+                        /**
+                         * Opt this launcher journey into the modern Journey Launcher (picker, card and hero shells). Launcher journeys only. Effective when true OR the organization flag `journey-modern-launcher` is on.
+                         *
+                         */
+                        modernLauncher?: boolean;
                     };
+                    /**
+                     * Offline journeys (ER-5432). Revision-owned like every other setting: effective on publish. The runtime prepares an offline pack for this journey only when the organization flag `journey-offline` is on AND `enabled` is true.
+                     *
+                     */
+                    offline?: {
+                        /**
+                         * Prepare this journey for offline use on devices that open it online first.
+                         */
+                        enabled: boolean;
+                        /**
+                         * How long a prepared pack stays fresh before the next online open refreshes it. Default 24.
+                         * example:
+                         * 24
+                         */
+                        packTtlHours?: number;
+                    } | null;
                 };
                 validationRules?: /**
                  * References to validation rules organized by blocks and fields.
@@ -2896,17 +3041,6 @@ declare namespace Paths {
                  * Manifest/Blueprint ID used to create/update the entity
                  */
                 _manifest?: string /* uuid */[];
-                /**
-                 * Blueprint field-locking contract (server-managed). Carries the
-                 * author plane (locks, default level) and the org plane (server-derived
-                 * overlay). Public writes never persist client-supplied values — the
-                 * stored contract is authoritative; it is written only by the
-                 * Blueprints install pipeline.
-                 *
-                 */
-                blueprint_customization?: {
-                    [name: string]: any;
-                };
                 createdBy?: string;
                 updatedBy?: string | null;
                 /**
@@ -2929,6 +3063,7 @@ declare namespace Paths {
                 featureFlags?: {
                     [name: string]: any;
                 };
+                templating?: Components.Schemas.JourneyTemplating;
                 /**
                  * example:
                  * 42
@@ -3052,6 +3187,15 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetJourneyTemplateVariables {
+        namespace Responses {
+            export type $200 = Components.Schemas.JourneyTemplateVariablesResponse;
+            export interface $401 {
+            }
+            export interface $403 {
+            }
+        }
+    }
     namespace GetJourneyV2 {
         namespace Parameters {
             /**
@@ -3316,7 +3460,28 @@ declare namespace Paths {
                          *
                          */
                         modernProducts?: boolean;
+                        /**
+                         * Opt this launcher journey into the modern Journey Launcher (picker, card and hero shells). Launcher journeys only. Effective when true OR the organization flag `journey-modern-launcher` is on.
+                         *
+                         */
+                        modernLauncher?: boolean;
                     };
+                    /**
+                     * Offline journeys (ER-5432). Revision-owned like every other setting: effective on publish. The runtime prepares an offline pack for this journey only when the organization flag `journey-offline` is on AND `enabled` is true.
+                     *
+                     */
+                    offline?: {
+                        /**
+                         * Prepare this journey for offline use on devices that open it online first.
+                         */
+                        enabled: boolean;
+                        /**
+                         * How long a prepared pack stays fresh before the next online open refreshes it. Default 24.
+                         * example:
+                         * 24
+                         */
+                        packTtlHours?: number;
+                    } | null;
                 };
                 validationRules?: /**
                  * References to validation rules organized by blocks and fields.
@@ -3344,17 +3509,6 @@ declare namespace Paths {
                  * Manifest/Blueprint ID used to create/update the entity
                  */
                 _manifest?: string /* uuid */[];
-                /**
-                 * Blueprint field-locking contract (server-managed). Carries the
-                 * author plane (locks, default level) and the org plane (server-derived
-                 * overlay). Public writes never persist client-supplied values — the
-                 * stored contract is authoritative; it is written only by the
-                 * Blueprints install pipeline.
-                 *
-                 */
-                blueprint_customization?: {
-                    [name: string]: any;
-                };
             }
         }
     }
@@ -3746,6 +3900,16 @@ interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetJourneyEnvironmentVariables.Responses.$200>
+  /**
+   * getJourneyTemplateVariables - getJourneyTemplateVariables
+   * 
+   * List what a journey template can reference beyond the entity's own attributes: the organization's Custom Variables and its scalar environment variables (`String`, `Text`, `Number`, `Boolean`). Names only, never values. Intended for the journey builder's variable picker; requires a journey authoring token, not an environments token.
+   */
+  'getJourneyTemplateVariables'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetJourneyTemplateVariables.Responses.$200>
   /**
    * getJourneyProducts - getJourneyProducts
    * 
@@ -4046,6 +4210,18 @@ interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetJourneyEnvironmentVariables.Responses.$200>
   }
+  ['/v1/journey/template-variables']: {
+    /**
+     * getJourneyTemplateVariables - getJourneyTemplateVariables
+     * 
+     * List what a journey template can reference beyond the entity's own attributes: the organization's Custom Variables and its scalar environment variables (`String`, `Text`, `Number`, `Boolean`). Names only, never values. Intended for the journey builder's variable picker; requires a journey authoring token, not an environments token.
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetJourneyTemplateVariables.Responses.$200>
+  }
   ['/v1/journey/products/{id}']: {
     /**
      * getJourneyProducts - getJourneyProducts
@@ -4238,6 +4414,11 @@ type JourneyRevisionList = Components.Schemas.JourneyRevisionList;
 type JourneyRevisionRequest = Components.Schemas.JourneyRevisionRequest;
 type JourneyRevisionSummary = Components.Schemas.JourneyRevisionSummary;
 type JourneyServedRevision = Components.Schemas.JourneyServedRevision;
+type JourneyTemplateVariablesResponse = Components.Schemas.JourneyTemplateVariablesResponse;
+type JourneyTemplating = Components.Schemas.JourneyTemplating;
+type JourneyTemplatingContext = Components.Schemas.JourneyTemplatingContext;
+type JourneyTemplatingLink = Components.Schemas.JourneyTemplatingLink;
+type JourneyTemplatingTranslatable = Components.Schemas.JourneyTemplatingTranslatable;
 type JourneyValidationError = Components.Schemas.JourneyValidationError;
 type JourneyValidationResponse = Components.Schemas.JourneyValidationResponse;
 type PatchUpdateJourneyRequest = Components.Schemas.PatchUpdateJourneyRequest;
@@ -4250,4 +4431,4 @@ type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
 type TemplateSettings = Components.Schemas.TemplateSettings;
 type ValidationRuleRef = Components.Schemas.ValidationRuleRef;
 
-export { type JourneyRevisionSummary as A, type ButtonOption as B, type Client as C, type JourneyServedRevision as D, type EnvironmentLink as E, type JourneyValidationError as F, type GenerateDocumentRequest as G, type JourneyValidationResponse as H, type PatchUpdateJourneyRequest as I, type Journey as J, type PublishResult as K, type PublishRevisionRequest as L, type SearchJourneysQueryRequest as M, type SearchJourneysResponse as N, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentLinkList as c, type EnvironmentMap as d, type EnvironmentMapEntry as e, type EnvironmentScalarList as f, type ExternalValueError as g, type GenerateDocumentResponse as h, type GetJourneysResponse as i, GetSettingsForJourney as j, type JourneyActivationGuarantee as k, type JourneyAuditInfo as l, type JourneyCreationRequest as m, type JourneyCreationRequestV2 as n, type JourneyEnvironmentResponse as o, type JourneyEnvironmentVariablesResponse as p, type JourneyExternalValuesRequest as q, type JourneyExternalValuesResponse as r, type JourneyFeatureFlags as s, type JourneyProductsResponse as t, type JourneyPublishState as u, type JourneyResponse as v, type JourneyRevision as w, type JourneyRevisionConflict as x, type JourneyRevisionList as y, type JourneyRevisionRequest as z };
+export { type JourneyRevisionSummary as A, type ButtonOption as B, type Client as C, type JourneyServedRevision as D, type EnvironmentLink as E, type JourneyTemplateVariablesResponse as F, type GenerateDocumentRequest as G, type JourneyTemplating as H, type JourneyTemplatingContext as I, type Journey as J, type JourneyTemplatingLink as K, type JourneyTemplatingTranslatable as L, type JourneyValidationError as M, type JourneyValidationResponse as N, type OperationMethods as O, Paths as P, type PatchUpdateJourneyRequest as Q, type PublishResult as R, type PublishRevisionRequest as S, type RuleRef as T, type S3Reference as U, type SearchJourneysQueryRequest as V, type SearchJourneysResponse as W, type TemplateSettings as X, type ValidationRuleRef as Y, Components as a, type PathsDictionary as b, type EnvironmentLinkList as c, type EnvironmentMap as d, type EnvironmentMapEntry as e, type EnvironmentScalarList as f, type ExternalValueError as g, type GenerateDocumentResponse as h, type GetJourneysResponse as i, GetSettingsForJourney as j, type JourneyActivationGuarantee as k, type JourneyAuditInfo as l, type JourneyCreationRequest as m, type JourneyCreationRequestV2 as n, type JourneyEnvironmentResponse as o, type JourneyEnvironmentVariablesResponse as p, type JourneyExternalValuesRequest as q, type JourneyExternalValuesResponse as r, type JourneyFeatureFlags as s, type JourneyProductsResponse as t, type JourneyPublishState as u, type JourneyResponse as v, type JourneyRevision as w, type JourneyRevisionConflict as x, type JourneyRevisionList as y, type JourneyRevisionRequest as z };