import {z} from 'zod' export type KnowledgeBaseImportSource = {external_id: string, source_hash: string, source_path?: (string | null) | undefined, source_created_at?: (string | null) | undefined, source_updated_at?: (string | null) | undefined, source_published_at?: (string | null) | undefined, source_metrics?: ({views?: number | undefined, helpful?: number | undefined, not_helpful?: number | undefined}) | undefined, related_external_ids?: Array | undefined}; export type KnowledgeBaseArticleInput = {title: string, slug: string, summary?: string | undefined, body_markdown: string, category_id?: (string | null) | undefined, position?: number | undefined, seo_title?: (string | null) | undefined, seo_description?: (string | null) | undefined, seo_keywords?: Array | undefined, related_article_ids?: Array | undefined, source?: (KnowledgeBaseImportSource | null) | undefined, path?: (string | null) | undefined, featured?: boolean | undefined, popular_rank?: (number | null) | undefined, cover_image_url?: (string | null) | undefined}; export type CreateApiProductsHelpDeskKnowledgeBaseArticlesArgs = {body: KnowledgeBaseArticleInput}; export type CreateApiProductsHelpDeskKnowledgeBaseArticlesOptions = {baseUrl?: string | undefined, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const knowledgeBaseImportSource = z.object({external_id: z.string().max(200), source_hash: z.string().max(128), source_path: z.string().nullable().optional(), source_created_at: z.string().nullable().optional(), source_updated_at: z.string().nullable().optional(), source_published_at: z.string().nullable().optional(), source_metrics: z.object({views: z.number().int().gte(0).optional(), helpful: z.number().int().gte(0).optional(), not_helpful: z.number().int().gte(0).optional()}).optional(), related_external_ids: z.array(z.string().max(200)).optional()}); export const knowledgeBaseArticle = z.object({title: z.string().max(160), slug: z.string().max(80), summary: z.string().max(500).optional(), body_markdown: z.string().optional(), category_id: z.string().nullable().optional(), position: z.number().int().gte(0).lte(1000000).optional(), seo_title: z.string().max(160).nullable().optional(), seo_description: z.string().max(500).nullable().optional(), seo_keywords: z.array(z.string().max(80)).optional(), related_article_ids: z.array(z.string().max(128)).optional(), source: knowledgeBaseImportSource.nullable().optional(), path: z.string().max(512).nullable().optional(), featured: z.boolean().optional(), popular_rank: z.number().int().gte(0).lte(1000000).nullable().optional(), cover_image_url: z.string().max(2048).nullable().optional(), article_id: z.string(), version: z.number().int().gte(0), current_revision_id: z.string(), published_revision_id: z.string().nullable(), source_revision_id: z.string().nullable().optional(), has_unpublished_changes: z.boolean(), archived: z.boolean().optional(), created_at: z.number().int().gte(0).optional(), updated_at: z.number().int().gte(0).optional(), asset_bindings: z.record(z.string(), z.string()).optional()}); export const responseMeta = z.object({api_version: z.string().optional(), request_id: z.string().optional(), response_ms: z.number().int().optional(), timestamp: z.number().int().optional(), pools: z.object({}).optional(), billing: z.object({past_due: z.boolean().optional()}).optional(), quota: z.object({limit: z.number().int().optional(), used: z.number().int().optional(), remaining: z.number().int().optional(), resets_at: z.number().int().optional()}).optional()}); export const createApiProductsHelpDeskKnowledgeBaseArticlesResponse = z.object({data: z.object({article: knowledgeBaseArticle}), meta: responseMeta.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 }; /** * Create an article draft * * POST /products/help-desk/knowledge-base/articles */ export const createApiProductsHelpDeskKnowledgeBaseArticles = async (args: CreateApiProductsHelpDeskKnowledgeBaseArticlesArgs, options?: CreateApiProductsHelpDeskKnowledgeBaseArticlesOptions) => { const {baseUrl = "https://api.sparkvault.com/v1", fetch: fetchFn = fetch, BearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/products/help-desk/knowledge-base/articles${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", 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(createApiProductsHelpDeskKnowledgeBaseArticlesResponse, await res.json()) };