import {z} from 'zod' export type GetApiApiV2CustomObjectsCustomObjectKeyFieldsArgs = {'page[before]'?: string | undefined, 'page[after]'?: string | undefined, 'page[size]'?: number | undefined, custom_object_key: string, include_standard_fields?: boolean | undefined}; export type GetApiApiV2CustomObjectsCustomObjectKeyFieldsOptions = {baseUrl?: string | undefined, apiTokenAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const customFieldOptionObject = z.object({id: z.number().int().optional(), name: z.string(), position: z.number().int().optional(), raw_name: z.string().optional(), url: z.string().optional(), value: z.string()}); export const customObjectField = z.object({active: z.boolean().optional(), created_at: z.string().optional(), custom_field_options: z.array(customFieldOptionObject).optional(), description: z.string().optional(), id: z.number().int().optional(), key: z.string(), position: z.number().int().optional(), raw_description: z.string().optional(), raw_title: z.string().optional(), regexp_for_validation: z.string().nullable().optional(), relationship_filter: z.object({}).optional(), relationship_target_type: z.string().optional(), system: z.boolean().optional(), tag: z.string().optional(), title: z.string(), type: z.string(), updated_at: z.string().optional(), url: z.string().optional()}); export const customObjectFieldsResponse = z.object({custom_object_fields: z.array(customObjectField).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 }; /** * List Custom Object Fields * * GET /api/v2/custom_objects/{custom_object_key}/fields */ export const getApiApiV2CustomObjectsCustomObjectKeyFields = async (args: GetApiApiV2CustomObjectsCustomObjectKeyFieldsArgs, options?: GetApiApiV2CustomObjectsCustomObjectKeyFieldsOptions) => { const {baseUrl = "https://example.zendesk.com", fetch: fetchFn = fetch, apiTokenAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['page[before]'] != null) query.append("page[before]", String(args['page[before]'])) if (args['page[after]'] != null) query.append("page[after]", String(args['page[after]'])) if (args['page[size]'] != null) query.append("page[size]", String(args['page[size]'])) if (args.include_standard_fields != null) query.append("include_standard_fields", String(args.include_standard_fields)) if (apiTokenAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${apiTokenAuth.username}:${apiTokenAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/custom_objects/${encodeURIComponent(String(args.custom_object_key))}/fields${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(customObjectFieldsResponse, await res.json()) };