import {z} from 'zod' export type GetApiJourneysTemplateIdArgs = {templateId: string, version?: string | undefined}; export type GetApiJourneysTemplateIdOptions = {baseUrl?: string | undefined, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const journeyState = z.enum(["DRAFT", "PUBLISHED"]); export const journeyConditionAtom = z.array(z.string()); export const journeyConditionGroup = z.object({AND: z.array(journeyConditionAtom).optional(), OR: z.array(journeyConditionAtom).optional()}); export const journeyConditionNestedGroup = z.object({AND: z.array(journeyConditionGroup).optional(), OR: z.array(journeyConditionGroup).optional()}); export const journeyConditionsField = z.union([journeyConditionAtom, journeyConditionGroup, journeyConditionNestedGroup]); export const journeyApiInvokeTriggerNode = z.object({id: z.string().min(1).optional(), type: z.literal("trigger"), trigger_type: z.literal("api-invoke"), schema: z.record(z.string(), z.unknown()).optional(), conditions: journeyConditionsField.optional()}); export const journeySegmentTriggerNode = z.object({id: z.string().min(1).optional(), type: z.literal("trigger"), trigger_type: z.literal("segment"), request_type: z.enum(["identify", "group", "track"]), event_id: z.string().min(1).optional(), conditions: journeyConditionsField.optional()}); export const journeyExperimentVariant = z.object({id: z.string().min(1), name: z.string().optional(), weight: z.number().gte(0), templateId: z.string().min(1)}); export const journeyExperiment = z.object({id: z.string().min(1).optional(), name: z.string().optional(), bucketingKey: z.string().min(1), variants: z.array(journeyExperimentVariant)}); export const journeySendNode = z.object({id: z.string().min(1).optional(), type: z.literal("send"), message: z.object({template: z.string().min(1).optional(), to: z.object({email_override: z.string().min(1).optional(), phone_number_override: z.string().min(1).optional(), user_id_override: z.string().min(1).optional()}).optional(), context: z.object({tenant_id: z.string().min(1)}).optional(), delay: z.object({until: z.string().min(1), timezone: z.string().min(1).optional()}).optional(), data: z.record(z.string(), z.unknown()).optional()}), experiment: journeyExperiment.optional(), conditions: journeyConditionsField.optional()}); export const journeyDelayDurationNode = z.object({id: z.string().min(1).optional(), type: z.literal("delay"), mode: z.literal("duration"), duration: z.string().min(1), conditions: journeyConditionsField.optional()}); export const journeyDelayUntilNode = z.object({id: z.string().min(1).optional(), type: z.literal("delay"), mode: z.literal("until"), until: z.string().min(1), conditions: journeyConditionsField.optional()}); export const journeyMergeStrategy = z.enum(["overwrite", "soft-merge", "replace", "none"]); export const journeyFetchGetDeleteNode = z.object({id: z.string().min(1).optional(), type: z.literal("fetch"), method: z.enum(["get", "delete"]), url: z.string().min(1), merge_strategy: journeyMergeStrategy, headers: z.record(z.string(), z.string()).optional(), query_params: z.record(z.string(), z.string()).optional(), response_schema: z.record(z.string(), z.unknown()).optional(), conditions: journeyConditionsField.optional()}); export const journeyFetchPostPutNode = z.object({id: z.string().min(1).optional(), type: z.literal("fetch"), method: z.enum(["post", "put"]), url: z.string().min(1), merge_strategy: journeyMergeStrategy, headers: z.record(z.string(), z.string()).optional(), query_params: z.record(z.string(), z.string()).optional(), response_schema: z.record(z.string(), z.unknown()).optional(), body: z.string().optional(), conditions: journeyConditionsField.optional()}); export const journeyAINode = z.object({id: z.string().min(1).optional(), type: z.literal("ai"), model: z.string().min(1).optional(), user_prompt: z.string().optional(), web_search: z.boolean().optional(), output_schema: z.record(z.string(), z.unknown()), conditions: journeyConditionsField.optional()}); export const journeyThrottleStaticNode = z.object({id: z.string().min(1).optional(), type: z.literal("throttle"), scope: z.enum(["user", "global"]), max_allowed: z.number().int().gte(1), period: z.string().min(1), conditions: journeyConditionsField.optional()}); export const journeyThrottleDynamicNode = z.object({id: z.string().min(1).optional(), type: z.literal("throttle"), scope: z.literal("dynamic"), max_allowed: z.number().int().gte(1), period: z.string().min(1), throttle_key: z.string().min(1), conditions: journeyConditionsField.optional()}); export const journeyBatchNode = z.object({id: z.string().min(1).optional(), type: z.literal("batch"), scope: z.literal("user"), wait_period: z.string().min(1), max_wait_period: z.string().min(1), max_items: z.number().int().gte(1).lte(1000).optional(), retain: z.object({type: z.enum(["first", "last", "highest", "lowest"]), count: z.number().int().gte(0).lte(25), sort_key: z.string().min(1).optional()}), category_key: z.string().min(1).max(256).optional(), conditions: journeyConditionsField.optional()}); export const journeyAddToDigestNode = z.object({id: z.string().min(1).optional(), type: z.literal("add-to-digest"), subscription_topic_id: z.string().min(1), conditions: journeyConditionsField.optional()}); export const journeyExitNode = z.object({id: z.string().min(1).optional(), type: z.literal("exit")}); export const journeyNode: z.ZodType = z.union([journeyApiInvokeTriggerNode, journeySegmentTriggerNode, journeySendNode, journeyDelayDurationNode, journeyDelayUntilNode, journeyFetchGetDeleteNode, journeyFetchPostPutNode, journeyAINode, journeyThrottleStaticNode, journeyThrottleDynamicNode, journeyBatchNode, journeyAddToDigestNode, journeyExitNode, z.object({id: z.string().min(1).optional(), type: z.literal("branch"), paths: z.array(z.object({label: z.string().min(1).optional(), conditions: journeyConditionsField, nodes: z.array(z.lazy(() => journeyNode))})), default: z.object({label: z.string().min(1).optional(), nodes: z.array(z.lazy(() => journeyNode))})})]); export const journeyResponse = z.object({id: z.string(), name: z.string(), state: journeyState, enabled: z.boolean(), nodes: z.array(journeyNode), created: z.number().int().nullable(), creator: z.string().nullable(), updated: z.number().int().nullable(), updater: z.string().nullable(), published: z.number().int().nullable()}); 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 }; /** * Fetch a journey by id * * GET /journeys/{templateId} */ export const getApiJourneysTemplateId = async (args: GetApiJourneysTemplateIdArgs, options?: GetApiJourneysTemplateIdOptions) => { const {baseUrl = "https://api.courier.com", fetch: fetchFn = fetch, BearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.version != null) query.append("version", String(args.version)) if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/journeys/${encodeURIComponent(String(args.templateId))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(journeyResponse, await res.json()) };