import {z} from 'zod' export type FunctionExpression = {function: '+' | '-' | '*' | '/', arg?: number | undefined} | {function: 'replace', search?: string | undefined, replacement?: (string | null) | undefined} | {function: 'substr', start?: number | undefined, length?: number | undefined} | {function: 'regexp_extract', pattern?: string | undefined, group?: number | undefined} | {function: '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'} | {function: 'cast_as_quantitative', default: number} | {function: 'cast_as_categorical', default: string} | {function: 'cast_as_categorical_array'} | {function: 'if', op?: ('>' | '<' | '<=' | '>=' | '=' | '!=' | 'is' | 'is\' | 'not') | undefined, right_value?: (number | null) | undefined, then?: number | undefined, else?: number | undefined}; export type ColumnExpression = {column: string, customerGroup?: (string | null) | undefined, functions?: (Array | null) | undefined}; export type StringExpression = {string: string, parameters?: (Array<{type?: 'String' | undefined, string?: string | undefined} | {type?: 'Timestamp' | undefined, format?: string | undefined} | {type?: ('SegmentName' | 'SegmentId' | 'AudienceId' | 'FunnelName' | 'StageName') | undefined}>) | undefined}; export type Columns = Array<{id?: string | undefined, column: string, source: ColumnExpression | StringExpression}>; export type DeprecatedScheduleType = 'cron' | 'daily' | 'hourly' | 'minutes_interval' | 'monthly' | 'none' | 'weekly'; export type StartAt = unknown | null; export type RepeatUnit = 'none' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'once'; export type RepeatFrequency = number; export type RepeatSubFrequency = Array; export type ActivationTemplateSyndicationBehaviorProperties = {columns?: Columns | undefined, behaviorTableName?: string | undefined, joinRow?: (number | null) | undefined, joinStrategy?: ('All' | 'First' | 'Last' | 'Top-N') | undefined, formatting?: ('rows' | 'cols') | undefined, orderBy?: (Array<{key?: string | undefined, order?: ('ascending' | 'descending') | undefined}>) | undefined}; export type ActivationTemplateFieldPropertiesLocked = {allColumns?: boolean | undefined, columns?: Record | undefined, connectionId?: boolean | undefined, connectorConfig?: (Record | null) | undefined, activationActionsEnabled?: boolean | undefined, syndicationBehavior?: ({tableName?: string | undefined, columns?: Record | undefined, lockAddColumn?: boolean | undefined, lockDeleteBehaviorTable?: boolean | undefined, lockEditBehaviorTable?: boolean | undefined, lockEditJoinRow?: boolean | undefined, lockEditJoinStrategy?: boolean | undefined, lockEditFormatting?: boolean | undefined, lockEditOrderBy?: boolean | undefined} | null) | undefined, lockAddColumn?: boolean | undefined, lockAddString?: boolean | undefined, lockAddBehavior?: boolean | undefined, lockEditSchedule?: boolean | undefined, lockEditNotification?: boolean | undefined, lockEditWorkflowExecution?: boolean | undefined, lockEditSequentialActivation?: boolean | undefined}; export type ActivationTemplateFieldProperties = {locked: ActivationTemplateFieldPropertiesLocked}; export type ActivationTemplateJsonApiParameters = {name: string, description?: string | undefined, kind?: number | undefined, allColumns?: boolean | undefined, columns?: Columns | undefined, scheduleType?: DeprecatedScheduleType | undefined, scheduleOption?: string | undefined, timezone?: string | undefined, startAt?: StartAt | undefined, endOn?: (string | null) | undefined, repeatUnit?: RepeatUnit | undefined, repeatFrequency?: RepeatFrequency | undefined, repeatSubFrequency?: RepeatSubFrequency | undefined, connectionId: number, connectorConfig?: (Record | null) | undefined, notifyOn?: (Array<'onSuccess' | 'onFailure'>) | undefined, emailRecipients?: Array | undefined, state: 'draft' | 'published', nestedWorkflowProjectName?: (string | null) | undefined, nestedWorkflowName?: (string | null) | undefined, lockEnabled?: boolean | undefined, runAfterJourneyRefresh?: boolean | undefined, syndicationBehavior?: (ActivationTemplateSyndicationBehaviorProperties | null) | undefined, fieldProperties?: ActivationTemplateFieldProperties | undefined}; export type RelationshipsFolderJsonApiResource = {data?: {id: string, type: 'folder-segment'} | undefined}; export type EntitiesActivationTemplateUpdateRepresentation = {id?: string | undefined, type?: 'activation-template' | undefined, attributes?: ActivationTemplateJsonApiParameters | undefined, relationships?: ({parentFolder?: RelationshipsFolderJsonApiResource | undefined}) | undefined}; export type PatchApiEntitiesActivationTemplatesIdArgs = {id: number, body: EntitiesActivationTemplateUpdateRepresentation}; export type PatchApiEntitiesActivationTemplatesIdOptions = {baseUrl?: 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 activationTemplateJsonApiResource = 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(), journeyCount: z.number().int().optional(), available: 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 entitiesGetActivationTemplateJsonApiResponse = z.object({data: activationTemplateJsonApiResource, 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 }; /** * Update an Activation Template * * PATCH /entities/activation_templates/{id} */ export const patchApiEntitiesActivationTemplatesId = async (args: PatchApiEntitiesActivationTemplatesIdArgs, options?: PatchApiEntitiesActivationTemplatesIdOptions) => { const {baseUrl = "https://api-cdp.treasuredata.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/vnd.treasuredata.v1+json") headers.set('accept', "application/json") const url = `${baseUrl.replace(/\/+$/, '')}/entities/activation_templates/${encodeURIComponent(String(args.id))}${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(entitiesGetActivationTemplateJsonApiResponse, await res.json()) };