import {z} from 'zod' export type GetApiV1HelpcenterArticlesArgs = {desk: string, collection?: string | undefined, language?: string | undefined, isDraft?: boolean | undefined, isExport?: boolean | undefined}; export type GetApiV1HelpcenterArticlesOptions = {baseUrl: string, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const helpdeskArticleUser = z.object({name: z.string().nullable().optional(), email: z.string().nullable().optional(), avatarUrl: z.string().nullable().optional()}); export const helpdeskArticleRate = z.object({visitor: z.unknown(), rate: z.number().nullable().optional(), createdAt: z.unknown(), updatedAt: z.unknown()}); export const articleStats = z.object({views: z.number().int().nullable().optional()}); export const helpdeskArticle: z.ZodType = z.object({_id: z.number().int().nullable().optional(), title: z.string().nullable().optional(), spoiler: z.string().nullable().optional(), language: z.string().nullable().optional(), body: z.string().nullable().optional(), user: helpdeskArticleUser, isDraft: z.boolean().nullable().optional(), slug: z.string().nullable().optional(), rates: z.array(helpdeskArticleRate).nullable().optional(), stats: articleStats.optional(), desk: z.string().min(1), departmentId: z.number().int().nullable().optional(), previous: z.lazy(() => helpdeskArticle.optional()), collection: z.number().int().nullable().optional(), createdAt: z.unknown(), updatedAt: z.unknown()}); export const helpdeskArticleQueryResult = z.object({totalItems: z.number().int().optional(), items: z.array(helpdeskArticle).nullable().optional()}); 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 }; /** * GET /v1/helpcenter/articles * * Also accepts auth: API Key */ export const getApiV1HelpcenterArticles = async (args: GetApiV1HelpcenterArticlesArgs, options: GetApiV1HelpcenterArticlesOptions) => { const {baseUrl, fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.desk != null) query.append("desk", String(args.desk)) if (args.collection != null) query.append("collection", String(args.collection)) if (args.language != null) query.append("language", String(args.language)) if (args.isDraft != null) query.append("isDraft", String(args.isDraft)) if (args.isExport != null) query.append("isExport", String(args.isExport)) if (Bearer !== undefined) headers.set('authorization', `Bearer ${Bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/helpcenter/articles${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(helpdeskArticleQueryResult, await res.json()) };