Skip to main content

BundleJourneyCandidate

@gravity-rail/sdk


@gravity-rail/sdk / BundleJourneyCandidate

Interface: BundleJourneyCandidate

One local Journey as the Bundle item that adds it.

item is the whole recipe, built by the server from the Journey: its definition, the actions of its steps and the Member labels they name. It is absent when problems name what the Journey must change first.

forms are the Forms its conditions read and workflows the Workflows its actions start. A draft that holds the Journey must hold each of them.

The recipe carries the Journey's enrollment conditions when every one is written on the Journey. enrollmentOmitted says the Journey has automatic enrollment that was left out: a saved Member Filter, or any enrollment where the platform does not yet write enrollment conditions.

Properties​

enrollmentOmitted?​

optional enrollmentOmitted: boolean


forms?​

optional forms: FormBundleItem[]


id​

id: number


item?​

optional item: JourneyBundleItem | null


name​

name: string


problems?​

optional problems: JourneyRecipeProblem[]


uuid​

uuid: string


workflows?​

optional workflows: BundleJourneyStartedWorkflow[]