@epilot/sdk 2.20.49 → 2.20.51

package/docs/journey.md

@@ -34,6 +34,7 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
 - [`publishJourneyRevision`](#publishjourneyrevision)
 - [`getJourneyPublishState`](#getjourneypublishstate)
 - [`getJourneyEnvironment`](#getjourneyenvironment)
+- [`resolveJourneyExternalValues`](#resolvejourneyexternalvalues)
 - [`getJourneyEnvironmentVariables`](#getjourneyenvironmentvariables)
 - [`getJourneyProducts`](#getjourneyproducts)
 - [`createJourney`](#createjourney)
@@ -56,7 +57,11 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
 - [`EnvironmentMap`](#environmentmap)
 - [`EnvironmentLink`](#environmentlink)
 - [`EnvironmentLinkList`](#environmentlinklist)
+- [`EnvironmentScalarList`](#environmentscalarlist)
 - [`JourneyEnvironmentResponse`](#journeyenvironmentresponse)
+- [`JourneyExternalValuesRequest`](#journeyexternalvaluesrequest)
+- [`JourneyExternalValuesResponse`](#journeyexternalvaluesresponse)
+- [`ExternalValueError`](#externalvalueerror)
 - [`JourneyEnvironmentVariablesResponse`](#journeyenvironmentvariablesresponse)
 - [`GetJourneysResponse`](#getjourneysresponse)
 - [`JourneyResponse`](#journeyresponse)
@@ -149,6 +154,7 @@ const { data } = await client.getJourney({
       "showStepperLabels": true,
       "stepperType": "numbers",
       "hideNextButton": true,
+      "guestVisible": true,
       "name": "string",
       "stepId": "string",
       "schema": {},
@@ -233,7 +239,10 @@ const { data } = await client.getJourney({
       "mode": "auto",
       "supportedRevision": 0
     },
-    "thirdPartyCookies": true
+    "thirdPartyCookies": true,
+    "betaFeatures": {
+      "modernProducts": true
+    }
   },
   "validationRules": {
     "block1": "rule123",
@@ -244,6 +253,7 @@ const { data } = await client.getJourney({
     }
   },
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+  "blueprint_customization": {},
   "createdBy": "string",
   "updatedBy": "string",
   "__lastModifiedAt": "string",
@@ -301,6 +311,7 @@ const { data } = await client.createJourneyRevision(
         showStepperLabels: true,
         stepperType: 'numbers',
         hideNextButton: true,
+        guestVisible: true,
         name: 'string',
         stepId: 'string',
         schema: {},
@@ -385,7 +396,10 @@ const { data } = await client.createJourneyRevision(
         mode: 'auto',
         supportedRevision: 0
       },
-      thirdPartyCookies: true
+      thirdPartyCookies: true,
+      betaFeatures: {
+        modernProducts: true
+      }
     },
     validationRules: {
       block1: 'rule123',
@@ -396,6 +410,7 @@ const { data } = await client.createJourneyRevision(
       }
     },
     _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
+    blueprint_customization: {},
     createdBy: 'string',
     updatedBy: 'string',
     __lastModifiedAt: 'string',
@@ -549,7 +564,8 @@ const { data } = await client.getJourneyRevision({
       "status": "string",
       "isActive": true,
       "savingProgress": {},
-      "thirdPartyCookies": true
+      "thirdPartyCookies": true,
+      "betaFeatures": {}
     },
     "validationRules": {
       "block1": "rule123",
@@ -557,6 +573,7 @@ const { data } = await client.getJourneyRevision({
       "block3": {}
     },
     "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+    "blueprint_customization": {},
     "createdBy": "string",
     "updatedBy": "string",
     "__lastModifiedAt": "string",
@@ -640,7 +657,7 @@ const { data } = await client.getJourneyPublishState({
 
 ### `getJourneyEnvironment`
 
-Resolve the environment variables referenced by this journey. Only browser-safe value types are returned.
+Resolve the environment variables referenced by this journey: the environment-backed datasources declared in its steps, whether they source a block's options or supply the value an attached validation
 
 `GET /v1/journey/configuration/{id}/environment`
 
@@ -667,6 +684,75 @@ const { data } = await client.getJourneyEnvironment({
       "datasourceId": "string",
       "code": "not_found"
     }
+  ],
+  "variables": [
+    {
+      "key": "string",
+      "type": "Text",
+      "value": "string"
+    }
+  ],
+  "variableErrors": [
+    {
+      "key": "string",
+      "code": "not_found"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### `resolveJourneyExternalValues`
+
+Resolve the External Values hooks this journey's validation rules compare against.
+
+`POST /v1/journey/configuration/{id}/external-values`
+
+```ts
+const { data } = await client.resolveJourneyExternalValues(
+  {
+    id: '123e4567-e89b-12d3-a456-426614174000',
+  },
+  {
+    items: [
+      {
+        datasourceId: 'string',
+        context: {}
+      }
+    ]
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "items": [
+    {
+      "datasourceId": "string",
+      "values": {},
+      "errors": [
+        {
+          "result_id": "string",
+          "code": "string",
+          "message": "string"
+        }
+      ],
+      "policy": {
+        "on_unavailable": "skip"
+      }
+    }
+  ],
+  "errors": [
+    {
+      "datasourceId": "string",
+      "code": "unknown_datasource"
+    }
   ]
 }
 ```
@@ -677,7 +763,7 @@ const { data } = await client.getJourneyEnvironment({
 
 ### `getJourneyEnvironmentVariables`
 
-List the organization's environment variables that a journey block may use as an options source. Only Map variables that currently hold a valid value are returned. Intended for the journey builder's a
+List the organization's client-safe environment variables a journey may use: Map and List``<Link>`` as an options source; Text, Number, Boolean and lists of them in logic conditions. Only variables that c
 
 `GET /v1/journey/environment-variables`
 
@@ -693,16 +779,8 @@ const { data } = await client.getJourneyEnvironmentVariables()
   "items": [
     {
       "key": "string",
-      "type": "Map",
-      "value": {
-        "fallbackLanguage": "de",
-        "options": [
-          {
-            "key": "string",
-            "value": "string"
-          }
-        ]
-      },
+      "type": "Text",
+      "value": "string",
       "description": "string"
     }
   ]
@@ -789,6 +867,7 @@ const { data } = await client.createJourney(
         showStepperLabels: true,
         stepperType: 'numbers',
         hideNextButton: true,
+        guestVisible: true,
         name: 'string',
         stepId: 'string',
         schema: {},
@@ -873,7 +952,10 @@ const { data } = await client.createJourney(
         mode: 'auto',
         supportedRevision: 0
       },
-      thirdPartyCookies: true
+      thirdPartyCookies: true,
+      betaFeatures: {
+        modernProducts: true
+      }
     },
     validationRules: {
       block1: 'rule123',
@@ -884,6 +966,7 @@ const { data } = await client.createJourney(
       }
     },
     _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
+    blueprint_customization: {},
     createdBy: 'string',
     updatedBy: 'string',
     __lastModifiedAt: 'string'
@@ -910,6 +993,7 @@ const { data } = await client.createJourney(
       "showStepperLabels": true,
       "stepperType": "numbers",
       "hideNextButton": true,
+      "guestVisible": true,
       "name": "string",
       "stepId": "string",
       "schema": {},
@@ -994,7 +1078,10 @@ const { data } = await client.createJourney(
       "mode": "auto",
       "supportedRevision": 0
     },
-    "thirdPartyCookies": true
+    "thirdPartyCookies": true,
+    "betaFeatures": {
+      "modernProducts": true
+    }
   },
   "validationRules": {
     "block1": "rule123",
@@ -1005,6 +1092,7 @@ const { data } = await client.createJourney(
     }
   },
   "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+  "blueprint_customization": {},
   "createdBy": "string",
   "updatedBy": "string",
   "__lastModifiedAt": "string",
@@ -1045,6 +1133,7 @@ const { data } = await client.updateJourney(
         showStepperLabels: true,
         stepperType: 'numbers',
         hideNextButton: true,
+        guestVisible: true,
         name: 'string',
         stepId: 'string',
         schema: {},
@@ -1129,7 +1218,10 @@ const { data } = await client.updateJourney(
         mode: 'auto',
         supportedRevision: 0
       },
-      thirdPartyCookies: true
+      thirdPartyCookies: true,
+      betaFeatures: {
+        modernProducts: true
+      }
     },
     validationRules: {
       block1: 'rule123',
@@ -1140,6 +1232,7 @@ const { data } = await client.updateJourney(
       }
     },
     _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
+    blueprint_customization: {},
     createdBy: 'string',
     updatedBy: 'string',
     __lastModifiedAt: 'string'
@@ -1227,7 +1320,8 @@ const { data } = await client.patchUpdateJourney(
       "status": "string",
       "isActive": true,
       "savingProgress": {},
-      "thirdPartyCookies": true
+      "thirdPartyCookies": true,
+      "betaFeatures": {}
     },
     "validationRules": {
       "block1": "rule123",
@@ -1235,6 +1329,7 @@ const { data } = await client.patchUpdateJourney(
       "block3": {}
     },
     "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+    "blueprint_customization": {},
     "createdBy": "string",
     "updatedBy": "string",
     "__lastModifiedAt": "string",
@@ -1402,6 +1497,7 @@ const { data } = await client.createJourneyV2(
         showStepperLabels: true,
         stepperType: 'numbers',
         hideNextButton: true,
+        guestVisible: true,
         name: 'string',
         stepId: 'string',
         schema: {},
@@ -1482,6 +1578,9 @@ const { data } = await client.createJourneyV2(
       savingProgress: {
         mode: 'auto',
         supportedRevision: 0
+      },
+      betaFeatures: {
+        modernProducts: true
       }
     },
     validationRules: {
@@ -1492,7 +1591,8 @@ const { data } = await client.createJourneyV2(
         field2: ['rule102', 'rule103']
       }
     },
-    _manifest: ['123e4567-e89b-12d3-a456-426614174000']
+    _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
+    blueprint_customization: {}
   },
 )
 ```
@@ -1515,6 +1615,7 @@ const { data } = await client.createJourneyV2(
       "showStepperLabels": true,
       "stepperType": "numbers",
       "hideNextButton": true,
+      "guestVisible": true,
       "name": "string",
       "stepId": "string",
       "schema": {},
@@ -1595,6 +1696,9 @@ const { data } = await client.createJourneyV2(
     "savingProgress": {
       "mode": "auto",
       "supportedRevision": 0
+    },
+    "betaFeatures": {
+      "modernProducts": true
     }
   },
   "validationRules": {
@@ -1605,7 +1709,8 @@ const { data } = await client.createJourneyV2(
       "field2": ["rule102", "rule103"]
     }
   },
-  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
+  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+  "blueprint_customization": {}
 }
 ```
 
@@ -1636,6 +1741,7 @@ const { data } = await client.updateJourneyV2(
         showStepperLabels: true,
         stepperType: 'numbers',
         hideNextButton: true,
+        guestVisible: true,
         name: 'string',
         stepId: 'string',
         schema: {},
@@ -1716,6 +1822,9 @@ const { data } = await client.updateJourneyV2(
       savingProgress: {
         mode: 'auto',
         supportedRevision: 0
+      },
+      betaFeatures: {
+        modernProducts: true
       }
     },
     validationRules: {
@@ -1726,7 +1835,8 @@ const { data } = await client.updateJourneyV2(
         field2: ['rule102', 'rule103']
       }
     },
-    _manifest: ['123e4567-e89b-12d3-a456-426614174000']
+    _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
+    blueprint_customization: {}
   },
 )
 ```
@@ -1749,6 +1859,7 @@ const { data } = await client.updateJourneyV2(
       "showStepperLabels": true,
       "stepperType": "numbers",
       "hideNextButton": true,
+      "guestVisible": true,
       "name": "string",
       "stepId": "string",
       "schema": {},
@@ -1829,6 +1940,9 @@ const { data } = await client.updateJourneyV2(
     "savingProgress": {
       "mode": "auto",
       "supportedRevision": 0
+    },
+    "betaFeatures": {
+      "modernProducts": true
     }
   },
   "validationRules": {
@@ -1839,7 +1953,8 @@ const { data } = await client.updateJourneyV2(
       "field2": ["rule102", "rule103"]
     }
   },
-  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
+  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+  "blueprint_customization": {}
 }
 ```
 
@@ -1881,6 +1996,7 @@ const { data } = await client.patchUpdateJourneyV2(
       "showStepperLabels": true,
       "stepperType": "numbers",
       "hideNextButton": true,
+      "guestVisible": true,
       "name": "string",
       "stepId": "string",
       "schema": {},
@@ -1961,6 +2077,9 @@ const { data } = await client.patchUpdateJourneyV2(
     "savingProgress": {
       "mode": "auto",
       "supportedRevision": 0
+    },
+    "betaFeatures": {
+      "modernProducts": true
     }
   },
   "validationRules": {
@@ -1971,7 +2090,8 @@ const { data } = await client.patchUpdateJourneyV2(
       "field2": ["rule102", "rule103"]
     }
   },
-  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
+  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+  "blueprint_customization": {}
 }
 ```
 
@@ -2010,6 +2130,7 @@ const { data } = await client.getJourneyV2({
       "showStepperLabels": true,
       "stepperType": "numbers",
       "hideNextButton": true,
+      "guestVisible": true,
       "name": "string",
       "stepId": "string",
       "schema": {},
@@ -2090,6 +2211,9 @@ const { data } = await client.getJourneyV2({
     "savingProgress": {
       "mode": "auto",
       "supportedRevision": 0
+    },
+    "betaFeatures": {
+      "modernProducts": true
     }
   },
   "validationRules": {
@@ -2100,7 +2224,8 @@ const { data } = await client.getJourneyV2({
       "field2": ["rule102", "rule103"]
     }
   },
-  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
+  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+  "blueprint_customization": {}
 }
 ```
 
@@ -2235,6 +2360,20 @@ type EnvironmentLinkList = {
 }
 ```
 
+### `EnvironmentScalarList`
+
+A list of scalars, served under this service's own `List`<Text>``,
+`List`<Number>`` or `List`<Boolean>`` token (ER-5455). Read by logic
+conditions; flattened to `items` by the journey runtime.
+
+
+```ts
+type EnvironmentScalarList = {
+  itemType: "Text" | "Number" | "Boolean"
+  items: string | number | boolean[]
+}
+```
+
 ### `JourneyEnvironmentResponse`
 
 ```ts
@@ -2255,6 +2394,62 @@ type JourneyEnvironmentResponse = {
     datasourceId: string
     code: "not_found" | "unsupported_type" | "not_set" | "invalid_value" | "incompatible_consumer"
   }>
+  variables?: Array<{
+    key: string
+    type: "Text" | "Number" | "Boolean" | "List<Text>" | "List<Number>" | "List<Boolean>"
+    value: string | number | boolean | {
+      itemType: { ... }
+      items: { ... }
+    }
+  }>
+  variableErrors?: Array<{
+    key: string
+    code: "not_found" | "unsupported_type" | "not_set" | "invalid_value"
+  }>
+}
+```
+
+### `JourneyExternalValuesRequest`
+
+```ts
+type JourneyExternalValuesRequest = {
+  items: Array<{
+    datasourceId: string
+    context: Record<string, unknown>
+  }>
+}
+```
+
+### `JourneyExternalValuesResponse`
+
+```ts
+type JourneyExternalValuesResponse = {
+  items: Array<{
+    datasourceId: string
+    values: Record<string, unknown>
+    errors?: Array<{
+      result_id?: { ... }
+      code: { ... }
+      message?: { ... }
+    }>
+    policy?: {
+      on_unavailable?: { ... }
+    }
+  }>
+  errors: Array<{
+    datasourceId: string
+    code: "unknown_datasource" | "resolver_unavailable"
+  }>
+}
+```
+
+### `ExternalValueError`
+
+```ts
+type ExternalValueError = {
+  result_id?: string
+  code: string
+  message?: string
 }
 ```
 
@@ -2264,14 +2459,17 @@ type JourneyEnvironmentResponse = {
 type JourneyEnvironmentVariablesResponse = {
   items: Array<{
     key: string
-    type: "Map" | "List<Link>"
-    value: {
+    type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>" | "List<Text>" | "List<Number>" | "List<Boolean>"
+    value: string | number | boolean | {
       fallbackLanguage?: { ... }
       options: { ... }
     } | {
       itemType: { ... }
       fallbackLanguage?: { ... }
       items: { ... }
+    } | {
+      itemType: { ... }
+      items: { ... }
     }
     description?: string
   }>
@@ -2302,6 +2500,7 @@ type JourneyResponse = {
       showStepperLabels?: { ... }
       stepperType?: { ... }
       hideNextButton?: { ... }
+      guestVisible?: { ... }
       name: { ... }
       stepId?: { ... }
       schema: { ... }
@@ -2375,18 +2574,17 @@ type JourneyResponse = {
       isActive?: { ... }
       savingProgress?: { ... }
       thirdPartyCookies?: { ... }
+      betaFeatures?: { ... }
     }
     validationRules?: Record<string, string | string[] | Record<string, string | string[]>>
     _manifest?: string // uuid[]
+    blueprint_customization?: Record<string, unknown>
     createdBy?: string
     updatedBy?: string
     __lastModifiedAt?: string
     createdAt: string
     lastModifiedAt: string
     deletedAt?: string
-    version: number
-    revisions: number
-    featureFlags?: Record<string, unknown>
   // ...
 }
 ```
@@ -2440,6 +2638,7 @@ type JourneyCreationRequest = {
     showStepperLabels?: boolean
     stepperType?: "numbers" | "progress bar"
     hideNextButton?: boolean
+    guestVisible?: boolean
     name: string
     stepId?: string
     schema: unknown
@@ -2525,7 +2724,6 @@ type JourneyCreationRequest = {
     }
     isPublished?: boolean
     status?: string
-    isActive?: boolean
   // ...
 }
 ```
@@ -2546,6 +2744,7 @@ type JourneyCreationRequestV2 = {
     showStepperLabels?: boolean
     stepperType?: "numbers" | "progress bar"
     hideNextButton?: boolean
+    guestVisible?: boolean
     name: string
     stepId?: string
     schema: unknown
@@ -2632,7 +2831,6 @@ type JourneyCreationRequestV2 = {
     savingProgress?: {
       mode?: { ... }
       supportedRevision?: { ... }
-    }
   // ...
 }
 ```
@@ -2691,6 +2889,7 @@ type Journey = {
     showStepperLabels?: boolean
     stepperType?: "numbers" | "progress bar"
     hideNextButton?: boolean
+    guestVisible?: boolean
     name: string
     stepId?: string
     schema: unknown
@@ -2776,7 +2975,6 @@ type Journey = {
     }
     isPublished?: boolean
     status?: string
-    isActive?: boolean
   // ...
 }
 ```
@@ -2845,6 +3043,7 @@ type JourneyRevisionRequest = {
     showStepperLabels?: boolean
     stepperType?: "numbers" | "progress bar"
     hideNextButton?: boolean
+    guestVisible?: boolean
     name: string
     stepId?: string
     schema: unknown
@@ -2930,7 +3129,6 @@ type JourneyRevisionRequest = {
     }
     isPublished?: boolean
     status?: string
-    isActive?: boolean
   // ...
 }
 ```
@@ -3004,6 +3202,7 @@ type JourneyRevision = {
       showStepperLabels?: { ... }
       stepperType?: { ... }
       hideNextButton?: { ... }
+      guestVisible?: { ... }
       name: { ... }
       stepId?: { ... }
       schema: { ... }
@@ -3077,10 +3276,9 @@ type JourneyRevision = {
       isActive?: { ... }
       savingProgress?: { ... }
       thirdPartyCookies?: { ... }
+      betaFeatures?: { ... }
     }
     validationRules?: Record<string, string | string[] | Record<string, string | string[]>>
-    _manifest?: string // uuid[]
-    createdBy?: string
   // ...
 }
 ```