import {z} from 'zod' export type PartialJourneyYamlJourneyBundleMetaAttributes = {name?: string | undefined, description?: string | undefined, latestJourneyId?: string | undefined}; export type RelationshipsFolderJsonApiResource = {data?: {id: string, type: 'folder-segment'} | undefined}; export type PartialJourneyYamlEntitiesJourneyBundleUpdateRepresentation = {id?: string | undefined, type?: 'journeyBundle' | undefined, attributes?: PartialJourneyYamlJourneyBundleMetaAttributes | undefined, relationships?: ({parentFolder?: RelationshipsFolderJsonApiResource | undefined}) | undefined}; export type PatchApiEntitiesJourneyBundlesJourneyBundleIdArgs = {journeyBundleId: number, body: PartialJourneyYamlEntitiesJourneyBundleUpdateRepresentation}; export type PatchApiEntitiesJourneyBundlesJourneyBundleIdOptions = {baseUrl?: string | undefined, TdApikeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const journeyJumpTarget = z.object({journeyId: z.string(), journeyStageId: z.string(), journeyBundleId: z.string().nullable().optional(), stageOrderIndex: z.number().int().nullable().optional(), jumpReferenceId: z.string().nullable().optional()}); export const journeyCriteria = z.object({name: z.string(), description: z.string().optional(), segmentId: z.string(), target: journeyJumpTarget.optional()}).nullable(); export const journeyWaitStepConditionPath = z.object({id: z.string(), name: z.string().optional(), segmentId: z.string().nullable().optional(), timedOutPath: z.boolean().optional(), moveAfter: z.number().int().gte(1).optional(), unit: z.enum(["day", "week"]).optional(), next: z.string().optional()}); export const journeyWaitStep = z.union([z.object({type: z.literal("WaitStep"), name: z.string(), waitStepType: z.literal("Duration"), waitStep: z.number().int(), waitStepUnit: z.enum(["day", "week"]), next: z.string().optional()}), z.object({type: z.literal("WaitStep"), name: z.string(), waitStepType: z.literal("Date"), waitUntilDate: z.string(), timezone: z.string(), next: z.string().optional()}), z.object({type: z.literal("WaitStep"), name: z.string(), waitStepType: z.literal("DaysOfTheWeek"), waitUntilDaysOfTheWeek: z.array(z.number().int().gte(1).lte(7)), timezone: z.string(), next: z.string().optional()}), z.object({type: z.literal("WaitStep"), waitStepType: z.literal("Condition"), conditions: z.array(journeyWaitStepConditionPath), description: z.string().nullable().optional()})]); export const journeyActivationStep = z.object({type: z.literal("Activation"), name: z.string(), journeyActivationStepId: z.string(), next: z.string().optional()}); export const journeyDecisionPointBranch = z.object({name: z.string(), segmentId: z.string(), excludedPath: z.boolean().optional(), next: z.string().optional()}); export const journeyDecisionPointStep = z.object({type: z.literal("DecisionPoint"), name: z.string(), branches: z.array(journeyDecisionPointBranch)}); export const journeyMergeStep = z.object({type: z.literal("Merge"), name: z.string().optional(), next: z.string().optional()}); export const journeyJumpStep = z.object({type: z.literal("Jump"), name: z.string(), target: journeyJumpTarget}); export const journeyEndStep = z.object({type: z.literal("End").optional(), name: z.string().optional()}).nullable(); export const journeyAbTestVariant = z.object({id: z.string(), name: z.string(), percentage: z.number(), next: z.string().optional(), isControlGroup: z.boolean().optional(), cappingAt: z.number().int().gte(1).lte(1000000).optional()}); export const journeyAbTestStep = z.object({type: z.literal("AbTest"), name: z.string(), customizedSplit: z.boolean(), uniqueId: z.string().optional(), randomizationMode: z.enum(["sticky", "reentry", "periodic"]).nullable().optional(), periodicCadence: z.enum(["weekly", "monthly", "yearly"]).optional(), periodicBoundaryMonth: z.number().int().gte(1).lte(12).optional(), periodicBoundaryDay: z.number().int().gte(1).lte(31).optional(), periodicBoundaryDayOfWeek: z.number().int().gte(1).lte(7).optional(), enabledCapping: z.boolean().optional(), winnerVariantId: z.string().nullable().optional(), variants: z.array(journeyAbTestVariant)}); export const journeyStep = z.object({uuid: z.union([journeyWaitStep, journeyActivationStep, journeyDecisionPointStep, journeyMergeStep, journeyJumpStep, journeyEndStep, journeyAbTestStep]).optional()}).nullable(); export const journeyStageJsonApiResource = z.object({id: z.string().optional(), name: z.string(), description: z.string().optional(), steps: journeyStep.optional(), rootStep: z.string().optional(), entryCriteria: journeyCriteria.optional(), milestone: journeyCriteria.optional(), exitCriterias: z.array(journeyCriteria).optional()}); export const execution = z.object({workflowId: z.string(), workflowSessionId: z.string(), createdAt: z.string(), finishedAt: z.string().nullable(), status: z.enum(["success", "canceled", "error", "canceling", "blocked", "queued", "running"]), workflowAttemptId: z.string()}); export const relationshipsFolderJsonApiResource = z.object({data: z.object({id: z.string(), type: z.literal("folder-segment")}).optional()}); export const relationshipsUserJsonApiResource = z.object({data: z.object({id: z.string(), type: z.literal("user")}).nullable().optional()}); export const journeyJsonApiResource = z.object({id: z.string(), type: z.literal("journey"), attributes: z.object({audienceId: z.string(), name: z.string(), description: z.string().nullable(), state: z.enum(["draft", "simulation", "launched"]), goal: journeyCriteria, createdAt: z.string(), updatedAt: z.string(), launchedAt: z.string().nullable(), journeyStages: z.array(journeyStageJsonApiResource), paused: z.boolean(), pausedAt: z.string().nullable(), allowReentry: z.boolean(), reentryMode: z.enum(["no_reentry", "reentry_unless_goal_achieved", "reentry_always"]).optional(), journeyBundleId: z.string().nullable().optional(), journeyBundleName: z.string().nullable().optional(), versionNumber: z.number().int().optional(), journeyBundleDescription: z.string().nullable().optional(), latestExecution: execution.nullable().optional()}), relationships: z.object({parentFolder: relationshipsFolderJsonApiResource.optional(), createdBy: relationshipsUserJsonApiResource.optional(), updatedBy: relationshipsUserJsonApiResource.optional()})}); export const userJsonApiResource = z.object({id: z.string(), type: z.literal("user"), attributes: z.object({tdUserId: z.string(), name: z.string()})}); export const partialJourneyYamlEntitiesJourneyBundleJsonApiResponse = z.object({name: z.string().optional(), description: z.string().optional(), latestJourneyId: z.unknown(), lastVersionNumber: z.number().int().optional(), journeys: z.array(journeyJsonApiResource).optional(), latestExecution: execution.optional(), parentSegmentLatestExecution: z.object({workflowId: z.string(), workflowSessionId: z.string(), createdAt: z.string(), finishedAt: z.string().nullable(), status: z.enum(["success", "canceled", "error", "canceling", "blocked", "queued", "running"]), workflowAttemptId: z.string(), audienceId: z.string().optional()}).optional(), isEligibleForOnDemand: z.boolean().optional(), onDemandIneligibilityReason: z.enum(["JOURNEY_NOT_ACTIVE", "PRIORITY_GROUP_JOURNEY_NOT_ELIGIBLE", "NOT_LATEST_VERSION", "PARENT_SEGMENT_NEVER_REFRESHED"]).nullable().optional(), parentSegmentLastRefreshedAt: z.string().nullable().optional(), included: z.array(z.union([userJsonApiResource, journeyJsonApiResource])).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Update the metadata of the journey bundle * * PATCH /entities/journey_bundles/{journeyBundleId} */ export const patchApiEntitiesJourneyBundlesJourneyBundleId = async (args: PatchApiEntitiesJourneyBundlesJourneyBundleIdArgs, options?: PatchApiEntitiesJourneyBundlesJourneyBundleIdOptions) => { const {baseUrl = "https://api-cdp.treasuredata.com", fetch: fetchFn = fetch, TdApikeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (TdApikeyAuth !== undefined) headers.set("Authorization", TdApikeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/entities/journey_bundles/${encodeURIComponent(String(args.journeyBundleId))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "PATCH", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(partialJourneyYamlEntitiesJourneyBundleJsonApiResponse, await res.json()) };