import {z} from 'zod' export type GetApiApiAnalyticsV1ManageGoalsArgs = {website_id: string, limit?: number | undefined, offset?: number | undefined}; export type GetApiApiAnalyticsV1ManageGoalsOptions = {baseUrl?: string | undefined, OAuth2ClientCredentials?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiApiAnalyticsV1ManageGoalsResponse = z.object({meta: z.object({total: z.number().int()}), data: z.array(z.object({type: z.literal("Goal"), id: z.string(), attributes: z.object({website_id: z.string(), name: z.string(), description: z.string().max(1024).optional(), trigger: z.enum(["url", "title", "event_name", "event_category", "event_action", "file", "external_website", "manually"]), pattern_type: z.enum(["contains", "exact", "regex"]).optional(), pattern: z.string().optional(), allow_multiple: z.boolean().optional(), case_sensitive: z.boolean().optional(), revenue: z.string()})}))}); 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 }; /** * List goals * * GET /api/analytics/v1/manage/goals/ */ export const getApiApiAnalyticsV1ManageGoals = async (args: GetApiApiAnalyticsV1ManageGoalsArgs, options?: GetApiApiAnalyticsV1ManageGoalsOptions) => { const {baseUrl = "https://example.piwik.pro", fetch: fetchFn = fetch, OAuth2ClientCredentials} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/vnd.api+json") if (args.website_id != null) query.append("website_id", String(args.website_id)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (OAuth2ClientCredentials !== undefined) headers.set('authorization', `Bearer ${OAuth2ClientCredentials}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/analytics/v1/manage/goals/${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(getApiApiAnalyticsV1ManageGoalsResponse, await res.json()) };