import {z} from 'zod' export type GetApiV1HelpcenterDesksArgs = {desk?: string | undefined, settings?: boolean | undefined}; export type GetApiV1HelpcenterDesksOptions = {baseUrl: string, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const helpdeskInfosetData = z.object({apiKey: z.string(), id: z.number().int()}); export const helpdeskChatWidgetSettings = z.object({apiKey: z.string().nullable().optional(), settings: z.unknown()}); export const helpdeskLanguageSettings = z.object({language: z.string(), title: z.string().nullable().optional(), subtitle: z.string().nullable().optional(), chatWidget: helpdeskChatWidgetSettings.optional()}); export const helpdeskFooterLink = z.object({title: z.string().nullable().optional(), url: z.string().nullable().optional()}); export const helpdeskSocialLink = z.object({platform: z.string().nullable().optional(), url: z.string().nullable().optional()}); export const helpdeskIntegrationGa = z.object({enabled: z.boolean().nullable().optional(), id: z.string().nullable().optional()}); export const helpdeskIntegrationSegment = z.object({enabled: z.boolean().nullable().optional(), writeKey: z.string().nullable().optional()}); export const helpdeskIntegrationAmplitude = z.object({enabled: z.boolean().nullable().optional(), apiKey: z.string().nullable().optional()}); export const helpdeskIntegrationSimpleAnalytics = z.object({enabled: z.boolean().nullable().optional()}); export const helpdeskIntegration = z.object({enabled: z.boolean().nullable().optional()}); export const helpdeskIntegrationFathom = z.object({enabled: z.boolean().nullable().optional(), siteId: z.string().nullable().optional()}); export const helpdeskIntegrationMomently = z.object({enabled: z.boolean().nullable().optional(), siteId: z.string().nullable().optional()}); export const helpdeskIntegrationDisqus = z.object({enabled: z.boolean().nullable().optional(), shortname: z.string().nullable().optional()}); export const helpdeskIntegrationCommento = z.object({enabled: z.boolean().nullable().optional()}); export const helpdeskIntegrationDiscourse = z.object({enabled: z.boolean().nullable().optional(), url: z.string().nullable().optional()}); export const helpdeskIntegrations = z.object({googleAnalytics: helpdeskIntegrationGa.optional(), segment: helpdeskIntegrationSegment.optional(), amplitude: helpdeskIntegrationAmplitude.optional(), simpleAnalytics: helpdeskIntegrationSimpleAnalytics.optional(), plausible: helpdeskIntegration.optional(), fathom: helpdeskIntegrationFathom.optional(), momently: helpdeskIntegrationMomently.optional(), disqus: helpdeskIntegrationDisqus.optional(), commento: helpdeskIntegrationCommento.optional(), discourse: helpdeskIntegrationDiscourse.optional()}); export const deskVisibility = z.union([z.literal(1), z.literal(2), z.literal(3)]); export const deskVisibilitySettings = z.object({type: deskVisibility.optional(), userGroupIds: z.array(z.number().int()).nullable().optional()}); export const desk = z.object({_id: z.string().nullable().optional(), _infoset: helpdeskInfosetData.optional(), slug: z.string(), domain: z.string().nullable().optional(), homepage: z.string().nullable().optional(), defaultLanguage: z.string(), languages: z.array(helpdeskLanguageSettings).nullable().optional(), faviconUrl: z.string().nullable().optional(), logoUrl: z.string().nullable().optional(), headerImgUrl: z.string().nullable().optional(), socialMediaImgUrl: z.string().nullable().optional(), color: z.string(), footerLinks: z.array(helpdeskFooterLink).nullable().optional(), socialLinks: z.array(helpdeskSocialLink).nullable().optional(), showInfosetLink: z.boolean().nullable().optional(), departmentId: z.number().int().nullable().optional(), integrations: helpdeskIntegrations.optional(), createdAt: z.unknown(), updatedAt: z.unknown(), visibility: deskVisibilitySettings.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 details of a desk * * GET /v1/helpcenter/desks * * Also accepts auth: API Key */ export const getApiV1HelpcenterDesks = async (args: GetApiV1HelpcenterDesksArgs, options: GetApiV1HelpcenterDesksOptions) => { 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.settings != null) query.append("settings", String(args.settings)) if (Bearer !== undefined) headers.set('authorization', `Bearer ${Bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/helpcenter/desks${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(desk, await res.json()) };