import {z} from 'zod' export type GetApiEntitiesSegmentsSegmentIdSyndicationsArgs = {segmentId: number}; export type GetApiEntitiesSegmentsSegmentIdSyndicationsOptions = {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 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 syndicationExecution = 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(), syndicationId: z.string().optional()}); export const syndicationBehaviorResponse = 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()}).nullable(); export const relationshipsBatchSegmentJsonApiResource = z.object({data: z.object({id: z.string(), type: z.literal("segment-batch")}).optional()}); export const relationshipsUserJsonApiResource = z.object({data: z.object({id: z.string(), type: z.literal("user")}).nullable().optional()}); export const syndicationJsonApiResource = z.object({id: z.string().optional(), type: z.literal("syndication").optional(), attributes: z.object({audienceId: z.string(), name: z.string(), description: z.string().nullable(), allColumns: z.boolean().optional(), columns: columns, scheduleType: deprecatedScheduleType.optional(), scheduleOption: z.string().optional(), timezone: z.string().optional(), startAt: startAt.optional(), endOn: z.string().nullable().optional(), runStatus: z.enum(["scheduled", "success", "error", "canceling", "canceled", "running", "waiting"]).nullable().optional(), repeatUnit: repeatUnit.optional(), repeatFrequency: repeatFrequency.optional(), repeatSubFrequency: repeatSubFrequency.optional(), connectionId: z.string().optional(), connectorConfig: z.object({}).nullable().optional(), valid: z.boolean().optional(), notifyOn: z.array(z.enum(["onSuccess", "onFailure"])).optional(), emailRecipients: z.array(z.number().int()).optional(), executions: z.array(syndicationExecution).optional(), createdAt: z.string(), updatedAt: z.string(), nestedWorkflowProjectName: z.string().optional(), nestedWorkflowName: z.string().optional(), activationActionsEnabled: z.boolean().optional(), lockEnabled: z.boolean().optional(), activationTemplateId: z.string().optional(), syndicationBehavior: syndicationBehaviorResponse.nullable().optional(), syndicationBehaviors: z.array(syndicationBehaviorResponse).nullable().optional()}).optional(), relationships: z.object({segment: relationshipsBatchSegmentJsonApiResource.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 entitiesSyndicationIndexJsonApiResponse = z.object({data: z.array(syndicationJsonApiResource), 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 list of activations * * GET /entities/segments/{segmentId}/syndications */ export const getApiEntitiesSegmentsSegmentIdSyndications = async (args: GetApiEntitiesSegmentsSegmentIdSyndicationsArgs, options?: GetApiEntitiesSegmentsSegmentIdSyndicationsOptions) => { const {baseUrl = "https://api-cdp.treasuredata.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/vnd.treasuredata.v1+json") const url = `${baseUrl.replace(/\/+$/, '')}/entities/segments/${encodeURIComponent(String(args.segmentId))}/syndications${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(entitiesSyndicationIndexJsonApiResponse, await res.json()) };