@epilot/sdk 2.20.9 → 2.20.11

package/docs/journey.md

@@ -28,6 +28,11 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
 - [`getJourneysByOrgId`](#getjourneysbyorgid)
 - [`getJourney`](#getjourney)
 - [`removeJourney`](#removejourney)
+- [`createJourneyRevision`](#createjourneyrevision)
+- [`listJourneyRevisions`](#listjourneyrevisions)
+- [`getJourneyRevision`](#getjourneyrevision)
+- [`publishJourneyRevision`](#publishjourneyrevision)
+- [`getJourneyPublishState`](#getjourneypublishstate)
 - [`getJourneyEnvironment`](#getjourneyenvironment)
 - [`getJourneyEnvironmentVariables`](#getjourneyenvironmentvariables)
 - [`getJourneyProducts`](#getjourneyproducts)
@@ -63,6 +68,14 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
 - [`JourneyActivationGuarantee`](#journeyactivationguarantee)
 - [`JourneyFeatureFlags`](#journeyfeatureflags)
 - [`JourneyAuditInfo`](#journeyauditinfo)
+- [`JourneyRevisionRequest`](#journeyrevisionrequest)
+- [`PublishRevisionRequest`](#publishrevisionrequest)
+- [`JourneyRevisionSummary`](#journeyrevisionsummary)
+- [`JourneyRevisionList`](#journeyrevisionlist)
+- [`JourneyRevision`](#journeyrevision)
+- [`JourneyRevisionConflict`](#journeyrevisionconflict)
+- [`JourneyPublishState`](#journeypublishstate)
+- [`PublishResult`](#publishresult)
 - [`JourneyValidationResponse`](#journeyvalidationresponse)
 - [`JourneyValidationError`](#journeyvalidationerror)
 - [`S3Reference`](#s3reference)
@@ -257,6 +270,368 @@ const { data } = await client.removeJourney({
 
 ---
 
+### `createJourneyRevision`
+
+Creates a revision: an immutable copy of the complete journey configuration, identified by `revision_id`. Nothing customers receive changes; the revision only becomes the published version when it is 
+
+`POST /v1/journey/configuration/{id}/revisions`
+
+```ts
+const { data } = await client.createJourneyRevision(
+  {
+    id: '123e4567-e89b-12d3-a456-426614174000',
+  },
+  {
+    journeyId: 'string',
+    organizationId: 'string',
+    brandId: 'string',
+    name: 'string',
+    steps: [
+      {
+        showStepName: true,
+        title: 'string',
+        subTitle: 'string',
+        showStepSubtitle: true,
+        showStepper: true,
+        showStepperLabels: true,
+        stepperType: 'numbers',
+        hideNextButton: true,
+        name: 'string',
+        stepId: 'string',
+        schema: {},
+        uischema: {},
+        maxWidth: 'small'
+      }
+    ],
+    design: {
+      logoUrl: 'string',
+      theme: {},
+      designTokens: {}
+    },
+    rules: [
+      {
+        type: 'inject',
+        sourceType: 'journey',
+        source: 'string',
+        target: 'string'
+      }
+    ],
+    logics: [
+      {
+        autoGeneratedId: 'string',
+        conditions: ['string'],
+        actions: ['string']
+      }
+    ],
+    logicsV4: {},
+    contextSchema: [
+      {
+        id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
+        type: 'string',
+        paramKey: 'string',
+        isRequired: true,
+        shouldLoadEntity: true,
+        description: 'string'
+      }
+    ],
+    journey_type: 'Sales template (Premium)',
+    protected: true,
+    protectedEditable: ['string'],
+    settings: {
+      embedOptions: {
+        mode: 'full-screen',
+        lang: 'de',
+        width: 'string',
+        topBar: true,
+        scrollToTop: true,
+        button: { /* ... */ }
+      },
+      safeModeAutomation: true,
+      canary: true,
+      designId: 'string',
+      templateId: 'string',
+      entityId: 'string',
+      mappingsAutomationId: 'string',
+      newMappings: true,
+      targetedCustomer: 'string',
+      description: 'string',
+      organizationSettings: {},
+      publicToken: 'string',
+      runtimeEntities: ['ORDER'],
+      filePurposes: ['string'],
+      entityTags: ['string'],
+      addressSuggestionsFileUrl: 'string',
+      addressSuggestionsFileId: 'string',
+      addressSuggestionsCountryCode: 'string',
+      addressSuggestionsEnableAutoComplete: true,
+      addressSuggestionsSource: ['string'],
+      addressSuggestionsEnableFreeText: true,
+      useNewDesign: true,
+      useAustrianLabels: true,
+      enableDarkMode: true,
+      accessMode: 'PUBLIC',
+      authGate: {
+        stepId: 'string'
+      },
+      isPublished: true,
+      status: 'string',
+      isActive: true,
+      savingProgress: {
+        mode: 'auto',
+        supportedRevision: 0
+      },
+      thirdPartyCookies: true
+    },
+    validationRules: {
+      block1: 'rule123',
+      block2: ['rule456', 'rule789'],
+      block3: {
+        field1: 'rule101',
+        field2: ['rule102', 'rule103']
+      }
+    },
+    _manifest: ['123e4567-e89b-12d3-a456-426614174000'],
+    createdBy: 'string',
+    updatedBy: 'string',
+    __lastModifiedAt: 'string',
+    parent_revision_id: '41',
+    based_on_revision_id: '37',
+    mapping_config_version: 12
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "revision_id": "42",
+  "created_at": "1970-01-01T00:00:00.000Z",
+  "created_by": "string",
+  "name": "Summer campaign",
+  "description": "string",
+  "published_at": "1970-01-01T00:00:00.000Z",
+  "is_published": true,
+  "mapping_config_version": 12
+}
+```
+
+</details>
+
+---
+
+### `listJourneyRevisions`
+
+Lists the journey's revision history, newest first. Metadata only, no configuration payload. `is_published` says whether a revision is the published version right now, which is a different question fr
+
+`GET /v1/journey/configuration/{id}/revisions`
+
+```ts
+const { data } = await client.listJourneyRevisions({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+  limit: 1,
+  cursor: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "results": [
+    {
+      "revision_id": "42",
+      "created_at": "1970-01-01T00:00:00.000Z",
+      "created_by": "string",
+      "name": "Summer campaign",
+      "description": "string",
+      "published_at": "1970-01-01T00:00:00.000Z",
+      "is_published": true,
+      "mapping_config_version": 12
+    }
+  ],
+  "next_cursor": "string"
+}
+```
+
+</details>
+
+---
+
+### `getJourneyRevision`
+
+Returns one revision with its full configuration, in the shape the builder holds a journey in, so it can be loaded straight into the editor as unsaved changes. Reading a revision changes nothing; a cl
+
+`GET /v1/journey/configuration/{id}/revisions/{revision_id}`
+
+```ts
+const { data } = await client.getJourneyRevision({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+  revision_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "revision_id": "42",
+  "created_at": "1970-01-01T00:00:00.000Z",
+  "created_by": "string",
+  "name": "Summer campaign",
+  "description": "string",
+  "published_at": "1970-01-01T00:00:00.000Z",
+  "is_published": true,
+  "mapping_config_version": 12,
+  "configuration": {
+    "journeyId": "string",
+    "organizationId": "string",
+    "brandId": "string",
+    "name": "string",
+    "steps": [
+      {}
+    ],
+    "design": {
+      "logoUrl": "string",
+      "theme": {},
+      "designTokens": {}
+    },
+    "rules": [
+      {}
+    ],
+    "logics": [
+      {}
+    ],
+    "logicsV4": {},
+    "contextSchema": [
+      {}
+    ],
+    "journey_type": "Sales template (Premium)",
+    "protected": true,
+    "protectedEditable": ["string"],
+    "settings": {
+      "embedOptions": {},
+      "safeModeAutomation": true,
+      "canary": true,
+      "designId": "string",
+      "templateId": "string",
+      "entityId": "string",
+      "mappingsAutomationId": "string",
+      "newMappings": true,
+      "targetedCustomer": "string",
+      "description": "string",
+      "organizationSettings": {},
+      "publicToken": "string",
+      "runtimeEntities": ["ORDER"],
+      "filePurposes": ["string"],
+      "entityTags": ["string"],
+      "addressSuggestionsFileUrl": "string",
+      "addressSuggestionsFileId": "string",
+      "addressSuggestionsCountryCode": "string",
+      "addressSuggestionsEnableAutoComplete": true,
+      "addressSuggestionsSource": ["string"],
+      "addressSuggestionsEnableFreeText": true,
+      "useNewDesign": true,
+      "useAustrianLabels": true,
+      "enableDarkMode": true,
+      "accessMode": "PUBLIC",
+      "authGate": {},
+      "isPublished": true,
+      "status": "string",
+      "isActive": true,
+      "savingProgress": {},
+      "thirdPartyCookies": true
+    },
+    "validationRules": {
+      "block1": "rule123",
+      "block2": ["rule456", "rule789"],
+      "block3": {}
+    },
+    "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+    "createdBy": "string",
+    "updatedBy": "string",
+    "__lastModifiedAt": "string",
+    "createdAt": "string",
+    "lastModifiedAt": "string",
+    "deletedAt": "string",
+    "version": 0,
+    "revisions": 0,
+    "featureFlags": {}
+  }
+}
+```
+
+</details>
+
+---
+
+### `publishJourneyRevision`
+
+Makes one revision the published version, the one customers receive, in a single transaction: the revision's configuration is copied onto the journey record, its datasource set onto the published data
+
+`POST /v1/journey/configuration/{id}/publish`
+
+```ts
+const { data } = await client.publishJourneyRevision(
+  {
+    id: '123e4567-e89b-12d3-a456-426614174000',
+  },
+  {
+    revision_id: '42',
+    name: 'Summer campaign',
+    description: 'string'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "revision_id": "42",
+  "name": "Summer campaign",
+  "published_at": "1970-01-01T00:00:00.000Z",
+  "published_by": "string",
+  "post_publish_warnings": ["string"]
+}
+```
+
+</details>
+
+---
+
+### `getJourneyPublishState`
+
+Answers which revision is the published version without paging through the history. A journey that has not adopted versioning yet returns `200` with `published_revision_id: null`, not `404`.
+
+`GET /v1/journey/configuration/{id}/publish-state`
+
+```ts
+const { data } = await client.getJourneyPublishState({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "published_revision_id": "42",
+  "published_at": "1970-01-01T00:00:00.000Z",
+  "published_by": "string"
+}
+```
+
+</details>
+
+---
+
 ### `getJourneyEnvironment`
 
 Resolve the environment variables referenced by this journey. Only browser-safe value types are returned.
@@ -2390,6 +2765,307 @@ type JourneyAuditInfo = {
 }
 ```
 
+### `JourneyRevisionRequest`
+
+The complete journey configuration a revision is created from, same shape as the `PUT` body. Server-managed attributes of the journey record (`revisions`, `version`, publish metadata) are ignored.
+
+
+```ts
+type JourneyRevisionRequest = {
+  journeyId?: string
+  organizationId: string
+  brandId?: string
+  name: string
+  steps: Array<{
+    showStepName?: boolean
+    title?: string
+    subTitle?: string
+    showStepSubtitle?: boolean
+    showStepper?: boolean
+    showStepperLabels?: boolean
+    stepperType?: "numbers" | "progress bar"
+    hideNextButton?: boolean
+    name: string
+    stepId?: string
+    schema: unknown
+    uischema: unknown
+    maxWidth?: "small" | "medium" | "large" | "extra large"
+  }>
+  design?: {
+    logoUrl?: string
+    theme?: Record<string, unknown>
+    designTokens?: object
+  }
+  rules?: Array<{
+    type: "inject" | "injectWithKey"
+    sourceType: "journey" | "step" | "block"
+    source: string
+    target: string
+  }>
+  logics?: Array<{
+    autoGeneratedId?: string
+    conditions: string[]
+    actions: string[]
+  }>
+  logicsV4?: Record<string, {
+    id?: string // uuid
+    protected?: boolean
+    action?: string
+    triggeredOn?: string
+    conditions?: Array<Array<{
+      operator?: { ... }
+      functionName?: { ... }
+      fact?: { ... }
+      value?: { ... }
+      args?: { ... }
+    }>>
+    settings?: object
+  }>
+  contextSchema?: Array<{
+    id?: string // uuid
+    type: string
+    paramKey: string
+    isRequired?: boolean
+    shouldLoadEntity?: boolean
+    description?: string
+  }>
+  journey_type?: string
+  protected?: boolean
+  protectedEditable?: string[]
+  settings?: {
+    embedOptions?: {
+      mode?: { ... }
+      lang?: { ... }
+      width?: { ... }
+      topBar?: { ... }
+      scrollToTop?: { ... }
+      button?: { ... }
+    }
+    safeModeAutomation?: boolean
+    canary?: boolean
+    designId: string
+    templateId?: string
+    entityId?: string
+    mappingsAutomationId?: string
+    newMappings?: boolean
+    targetedCustomer?: string
+    description?: string
+    organizationSettings?: Record<string, boolean>
+    publicToken?: string
+    runtimeEntities?: "ORDER" | "OPPORTUNITY"[]
+    filePurposes?: string[]
+    entityTags?: string[]
+    addressSuggestionsFileUrl?: string
+    addressSuggestionsFileId?: string
+    addressSuggestionsCountryCode?: string
+    addressSuggestionsEnableAutoComplete?: boolean
+    addressSuggestionsSource?: string[]
+    addressSuggestionsEnableFreeText?: boolean
+    useNewDesign?: boolean
+    useAustrianLabels?: boolean
+    enableDarkMode?: boolean
+    accessMode?: "PUBLIC" | "PRIVATE"
+    authGate?: {
+      stepId: { ... }
+    }
+    isPublished?: boolean
+    status?: string
+    isActive?: boolean
+  // ...
+}
+```
+
+### `PublishRevisionRequest`
+
+```ts
+type PublishRevisionRequest = {
+  revision_id: string
+  name?: string
+  description?: string
+}
+```
+
+### `JourneyRevisionSummary`
+
+```ts
+type JourneyRevisionSummary = {
+  revision_id: string
+  created_at: string // date-time
+  created_by?: string
+  name?: string
+  description?: string
+  published_at?: string // date-time
+  is_published: boolean
+  mapping_config_version?: number
+}
+```
+
+### `JourneyRevisionList`
+
+```ts
+type JourneyRevisionList = {
+  results: Array<{
+    revision_id: string
+    created_at: string // date-time
+    created_by?: string
+    name?: string
+    description?: string
+    published_at?: string // date-time
+    is_published: boolean
+    mapping_config_version?: number
+  }>
+  next_cursor?: string
+}
+```
+
+### `JourneyRevision`
+
+```ts
+type JourneyRevision = {
+  revision_id: string
+  created_at: string // date-time
+  created_by?: string
+  name?: string
+  description?: string
+  published_at?: string // date-time
+  is_published: boolean
+  mapping_config_version?: number
+  configuration: {
+    journeyId?: string
+    organizationId: string
+    brandId?: string
+    name: string
+    steps: Array<{
+      showStepName?: { ... }
+      title?: { ... }
+      subTitle?: { ... }
+      showStepSubtitle?: { ... }
+      showStepper?: { ... }
+      showStepperLabels?: { ... }
+      stepperType?: { ... }
+      hideNextButton?: { ... }
+      name: { ... }
+      stepId?: { ... }
+      schema: { ... }
+      uischema: { ... }
+      maxWidth?: { ... }
+    }>
+    design?: {
+      logoUrl?: { ... }
+      theme?: { ... }
+      designTokens?: { ... }
+    }
+    rules?: Array<{
+      type: { ... }
+      sourceType: { ... }
+      source: { ... }
+      target: { ... }
+    }>
+    logics?: Array<{
+      autoGeneratedId?: { ... }
+      conditions: { ... }
+      actions: { ... }
+    }>
+    logicsV4?: Record<string, {
+      id?: { ... }
+      protected?: { ... }
+      action?: { ... }
+      triggeredOn?: { ... }
+      conditions?: { ... }
+      settings?: { ... }
+    }>
+    contextSchema?: Array<{
+      id?: { ... }
+      type: { ... }
+      paramKey: { ... }
+      isRequired?: { ... }
+      shouldLoadEntity?: { ... }
+      description?: { ... }
+    }>
+    journey_type?: string
+    protected?: boolean
+    protectedEditable?: string[]
+    settings?: {
+      embedOptions?: { ... }
+      safeModeAutomation?: { ... }
+      canary?: { ... }
+      designId: { ... }
+      templateId?: { ... }
+      entityId?: { ... }
+      mappingsAutomationId?: { ... }
+      newMappings?: { ... }
+      targetedCustomer?: { ... }
+      description?: { ... }
+      organizationSettings?: { ... }
+      publicToken?: { ... }
+      runtimeEntities?: { ... }
+      filePurposes?: { ... }
+      entityTags?: { ... }
+      addressSuggestionsFileUrl?: { ... }
+      addressSuggestionsFileId?: { ... }
+      addressSuggestionsCountryCode?: { ... }
+      addressSuggestionsEnableAutoComplete?: { ... }
+      addressSuggestionsSource?: { ... }
+      addressSuggestionsEnableFreeText?: { ... }
+      useNewDesign?: { ... }
+      useAustrianLabels?: { ... }
+      enableDarkMode?: { ... }
+      accessMode?: { ... }
+      authGate?: { ... }
+      isPublished?: { ... }
+      status?: { ... }
+      isActive?: { ... }
+      savingProgress?: { ... }
+      thirdPartyCookies?: { ... }
+    }
+    validationRules?: Record<string, string | string[] | Record<string, string | string[]>>
+    _manifest?: string // uuid[]
+    createdBy?: string
+  // ...
+}
+```
+
+### `JourneyRevisionConflict`
+
+```ts
+type JourneyRevisionConflict = {
+  message: string
+  latest_revision: {
+    revision_id: string
+    created_at: string // date-time
+    created_by?: string
+    name?: string
+    description?: string
+    published_at?: string // date-time
+    is_published: boolean
+    mapping_config_version?: number
+  }
+}
+```
+
+### `JourneyPublishState`
+
+```ts
+type JourneyPublishState = {
+  journey_id: string // uuid
+  published_revision_id: string
+  published_at?: string // date-time
+  published_by?: string
+}
+```
+
+### `PublishResult`
+
+```ts
+type PublishResult = {
+  revision_id: string
+  name: string
+  published_at: string // date-time
+  published_by?: string
+  post_publish_warnings: string[]
+}
+```
+
 ### `JourneyValidationResponse`
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.9",
+  "version": "2.20.11",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/definitions/access-token-runtime.json

@@ -1 +0,0 @@
-{"s":"https://access-token.sls.epilot.io","o":[["createAccessToken","post","/v1/access-tokens",null,1],["listAccessTokens","get","/v1/access-tokens",[["token_type","q"]]],["revokeAccessToken","delete","/v1/access-tokens/{id}",[["id","p",true]]],["getAccessTokenJwks","get","/v1/access-tokens/.well-known/jwks.json"],["getAccessTokenOIDC","get","/v1/access-tokens/.well-known/openid-configuration"],["getPublicTokenJwks","get","/v1/access-tokens/public/.well-known/jwks.json"],["getPortalPreviewTokenJwks","get","/v1/access-tokens/portal-preview/.well-known/jwks.json"],["getPublicTokenOIDC","get","/v1/access-tokens/public/.well-known/openid-configuration"],["getPortalPreviewTokenOIDC","get","/v1/access-tokens/portal-preview/.well-known/openid-configuration"]],"v":"3.0.3"}