import {z} from 'zod' export type JourneyJumpTarget = {journeyId: string, journeyStageId: string, journeyBundleId?: (string | null) | undefined, stageOrderIndex?: (number | null) | undefined, jumpReferenceId?: (string | null) | undefined}; export type JourneyCriteria = {name: string, description?: string | undefined, segmentId: string, target?: JourneyJumpTarget | undefined} | null; export type JourneyWaitStepConditionPath = {id: string, name?: string | undefined, segmentId?: (string | null) | undefined, timedOutPath?: boolean | undefined, moveAfter?: number | undefined, unit?: ('day' | 'week') | undefined, next?: string | undefined}; export type JourneyWaitStep = {type: 'WaitStep', name: string, waitStepType: 'Duration', waitStep: number, waitStepUnit: 'day' | 'week', next?: string | undefined} | {type: 'WaitStep', name: string, waitStepType: 'Date', waitUntilDate: string, timezone: string, next?: string | undefined} | {type: 'WaitStep', name: string, waitStepType: 'DaysOfTheWeek', waitUntilDaysOfTheWeek: Array, timezone: string, next?: string | undefined} | {type: 'WaitStep', waitStepType: 'Condition', conditions: Array, description?: (string | null) | undefined}; export type JourneyActivationStep = {type: 'Activation', name: string, journeyActivationStepId: string, next?: string | undefined}; export type JourneyDecisionPointBranch = {name: string, segmentId: string, excludedPath?: boolean | undefined, next?: string | undefined}; export type JourneyDecisionPointStep = {type: 'DecisionPoint', name: string, branches: Array}; export type JourneyMergeStep = {type: 'Merge', name?: string | undefined, next?: string | undefined}; export type JourneyJumpStep = {type: 'Jump', name: string, target: JourneyJumpTarget}; export type JourneyEndStep = {type?: 'End' | undefined, name?: string | undefined} | null; export type JourneyAbTestVariant = {id: string, name: string, percentage: number, next?: string | undefined, isControlGroup?: boolean | undefined, cappingAt?: number | undefined}; export type JourneyAbTestStep = {type: 'AbTest', name: string, customizedSplit: boolean, uniqueId?: string | undefined, randomizationMode?: ('sticky' | 'reentry' | 'periodic' | null) | undefined, periodicCadence?: ('weekly' | 'monthly' | 'yearly') | undefined, periodicBoundaryMonth?: number | undefined, periodicBoundaryDay?: number | undefined, periodicBoundaryDayOfWeek?: number | undefined, enabledCapping?: boolean | undefined, winnerVariantId?: (string | null) | undefined, variants: Array}; export type JourneyStep = {uuid?: (JourneyWaitStep | JourneyActivationStep | JourneyDecisionPointStep | JourneyMergeStep | JourneyJumpStep | JourneyEndStep | JourneyAbTestStep) | undefined} | null; export type JourneyStageJsonApiResource = {id?: string | undefined, name: string, description?: string | undefined, steps?: JourneyStep | undefined, rootStep?: string | undefined, entryCriteria?: JourneyCriteria | undefined, milestone?: JourneyCriteria | undefined, exitCriterias?: Array | undefined}; export type EntitiesJourneyUpdateRepresentation = {type?: 'journey' | undefined, attributes?: ({name: string, description?: (string | null) | undefined, state?: ('draft' | 'simulation' | 'launched') | undefined, goal?: JourneyCriteria | undefined, journeyStages?: Array | undefined, allowReentry?: boolean | undefined, reentryMode?: ('no_reentry' | 'reentry_unless_goal_achieved' | 'reentry_always') | undefined, journeyBundleId?: (string | null) | undefined, journeyBundleName?: (string | null) | undefined, journeyBundleDescription?: (string | null) | undefined}) | undefined}; export type CreateApiEntitiesJourneysJourneyIdActivationTemplatesForStepArgs = {journeyId: number, stepId?: string | undefined, body: EntitiesJourneyUpdateRepresentation}; export type CreateApiEntitiesJourneysJourneyIdActivationTemplatesForStepOptions = {baseUrl?: string | undefined, TdApikeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const functionExpression = z.union([z.object({function: z.enum(["+", "-", "*", "/"]), arg: z.number().optional()}), z.object({function: z.literal("replace"), search: z.string().optional(), replacement: z.string().nullable().optional()}), z.object({function: z.literal("substr"), start: z.number().optional(), length: z.number().optional()}), z.object({function: z.literal("regexp_extract"), pattern: z.string().optional(), group: z.number().optional()}), z.object({function: z.enum(["day_of_week", "from_iso8601_timestamp", "ln", "elapsed_days", "td_ip_to_least_specific_subdivision_name", "td_ip_to_country_name", "td_ip_to_city_name", "td_ip_to_connection_type", "td_ip_to_domain"])}), z.object({function: z.literal("cast_as_quantitative"), default: z.number()}), z.object({function: z.literal("cast_as_categorical"), default: z.string()}), z.object({function: z.literal("cast_as_categorical_array")}), z.object({function: z.literal("if"), op: z.enum([">", "<", "<=", ">=", "=", "!=", "is", "is\", "not"]).optional(), right_value: z.number().nullable().optional(), then: z.number().optional(), else: z.number().optional()})]); export const columnExpression = z.object({column: z.string(), customerGroup: z.string().nullable().optional(), functions: z.array(functionExpression).nullable().optional()}); export const stringExpression = z.object({string: z.string(), parameters: z.array(z.union([z.object({type: z.literal("String").optional(), string: z.string().optional()}), z.object({type: z.literal("Timestamp").optional(), format: z.string().optional()}), z.object({type: z.enum(["SegmentName", "SegmentId", "AudienceId", "FunnelName", "StageName"]).optional()})])).optional()}); export const columns = z.array(z.object({id: z.string().optional(), column: z.string(), source: z.union([columnExpression, stringExpression])})); export const nullValue = z.object({thisKeyNeverHit: z.string().optional()}).nullable(); export const deprecatedScheduleType = z.enum(["cron", "daily", "hourly", "minutes_interval", "monthly", "none", "weekly"]); export const startAt = z.string().nullable(); export const repeatUnit = z.enum(["none", "minute", "hour", "day", "week", "month", "once"]); export const repeatFrequency = z.number().int(); export const repeatSubFrequency = z.array(z.number().int()); export const activationTemplateSyndicationBehaviorProperties = z.object({columns: columns.optional(), behaviorTableName: z.string().optional(), joinRow: z.number().int().nullable().optional(), joinStrategy: z.enum(["All", "First", "Last", "Top-N"]).optional(), formatting: z.enum(["rows", "cols"]).optional(), orderBy: z.array(z.object({key: z.string().optional(), order: z.enum(["ascending", "descending"]).optional()})).optional()}); export const activationTemplateFieldPropertiesLocked = z.object({allColumns: z.boolean().optional(), columns: z.object({}).optional(), connectionId: z.boolean().optional(), connectorConfig: z.object({}).nullable().optional(), activationActionsEnabled: z.boolean().optional(), syndicationBehavior: z.object({tableName: z.string().optional(), columns: z.object({}).optional(), lockAddColumn: z.boolean().optional(), lockDeleteBehaviorTable: z.boolean().optional(), lockEditBehaviorTable: z.boolean().optional(), lockEditJoinRow: z.boolean().optional(), lockEditJoinStrategy: z.boolean().optional(), lockEditFormatting: z.boolean().optional(), lockEditOrderBy: z.boolean().optional()}).nullable().optional(), lockAddColumn: z.boolean().optional(), lockAddString: z.boolean().optional(), lockAddBehavior: z.boolean().optional(), lockEditSchedule: z.boolean().optional(), lockEditNotification: z.boolean().optional(), lockEditWorkflowExecution: z.boolean().optional(), lockEditSequentialActivation: z.boolean().optional()}); export const activationTemplateFieldProperties = z.object({locked: activationTemplateFieldPropertiesLocked}); 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 activationTemplateIndexJsonApiResponse = z.object({id: z.string().optional(), type: z.literal("activation-template").optional(), attributes: z.object({audienceId: z.string(), name: z.string(), description: z.string().nullable(), kind: z.number().int().optional(), allColumns: z.boolean().optional(), columns: z.union([columns, nullValue]).optional(), scheduleType: deprecatedScheduleType.optional(), scheduleOption: z.string().nullable().optional(), timezone: z.string().nullable().optional(), startAt: startAt.optional(), endOn: z.string().nullable().optional(), repeatUnit: repeatUnit.optional(), repeatFrequency: repeatFrequency.optional(), repeatSubFrequency: repeatSubFrequency.optional(), connectionId: z.string().nullable().optional(), connectorConfig: z.object({}).nullable().optional(), notifyOn: z.array(z.enum(["onSuccess", "onFailure"])).optional(), emailRecipients: z.array(z.number().int()).optional(), createdAt: z.string(), updatedAt: z.string(), state: z.enum(["draft", "published"]).optional(), nestedWorkflowProjectName: z.string().nullable().optional(), nestedWorkflowName: z.string().nullable().optional(), activationActionsEnabled: z.boolean().optional(), lockEnabled: z.boolean().optional(), runAfterJourneyRefresh: z.boolean().nullable().optional(), syndicationBehavior: activationTemplateSyndicationBehaviorProperties.nullable().optional(), fieldProperties: activationTemplateFieldProperties.optional(), activationCount: z.number().int().optional(), available: z.boolean().optional(), availableBySegment: z.boolean().optional(), availableByStep: z.boolean().optional()}).optional(), relationships: z.object({parentFolder: relationshipsFolderJsonApiResource.optional(), createdBy: relationshipsUserJsonApiResource.optional(), updatedBy: relationshipsUserJsonApiResource.optional()}).optional()}); export const userJsonApiResource = z.object({id: z.string(), type: z.literal("user"), attributes: z.object({tdUserId: z.string(), name: z.string()})}); export const entitiesActivationTemplateIndexJsonApiResponse = z.object({data: z.array(activationTemplateIndexJsonApiResponse), included: z.array(userJsonApiResource)}); 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 }; /** * Retrieve a list of journey activation templates of specified step * * POST /entities/journeys/{journeyId}/activation_templates_for_step */ export const createApiEntitiesJourneysJourneyIdActivationTemplatesForStep = async (args: CreateApiEntitiesJourneysJourneyIdActivationTemplatesForStepArgs, options?: CreateApiEntitiesJourneysJourneyIdActivationTemplatesForStepOptions) => { 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/vnd.treasuredata.v1+json") headers.set('accept', "application/json") if (args.stepId != null) query.append("stepId", String(args.stepId)) if (TdApikeyAuth !== undefined) headers.set("Authorization", TdApikeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/entities/journeys/${encodeURIComponent(String(args.journeyId))}/activation_templates_for_step${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", 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(entitiesActivationTemplateIndexJsonApiResponse, await res.json()) };