import {z} from 'zod' export type GetApiApiCustomFieldsArgs = {object_type: 'Ticket' | 'Customer', search?: string | undefined, archived?: boolean | undefined, order_by?: ('priority:asc' | 'priority:desc') | undefined, cursor?: string | undefined, limit?: number | undefined}; export type GetApiApiCustomFieldsOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const objectType = z.enum(["Ticket", "Customer"]); export const requirementType = z.enum(["visible", "required", "conditional"]); export const managedTicketFieldType = z.enum(["contact_reason", "product", "resolution", "ai_intent", "ai_outcome", "ai_sales", "ai_discount", "ai_journey", "managed_sentiment", "call_status"]); export const managedCustomerFieldType = z.literal("customer_type"); export const textInputSettings = z.object({input_type: z.literal("input"), placeholder: z.string().max(1024).optional()}); export const dropdownInputSettingsSettings = z.object({input_type: z.literal("dropdown"), choices: z.array(z.string()), default: z.string().optional()}); export const textDataTypeDefinition = z.object({data_type: z.literal("text"), input_settings: z.discriminatedUnion("input_type", [textInputSettings, dropdownInputSettingsSettings])}); export const numberInputSettings = z.object({input_type: z.literal("input_number"), placeholder: z.string().max(1024).optional(), min: z.union([z.number(), z.string()]).optional(), max: z.union([z.number(), z.string()]).optional()}); export const numberDataTypeDefinition = z.object({data_type: z.literal("number"), input_settings: numberInputSettings}); export const booleanDropdownInputSettings = z.object({input_type: z.literal("dropdown"), choices: z.array(z.boolean()).optional(), default: z.boolean().optional()}); export const booleanDataTypeDefinition = z.object({data_type: z.literal("boolean"), input_settings: booleanDropdownInputSettings}); export const customField = z.object({id: z.number().int(), external_id: z.string().optional(), object_type: objectType, label: z.string().max(255), description: z.string().max(1024).optional(), priority: z.number().int().gte(0), required: z.boolean(), requirement_type: requirementType, managed_type: z.union([managedTicketFieldType, managedCustomerFieldType]).optional(), definition: z.discriminatedUnion("data_type", [textDataTypeDefinition, numberDataTypeDefinition, booleanDataTypeDefinition]), created_datetime: z.string(), updated_datetime: z.string(), deactivated_datetime: z.string().optional()}); export const cursorPaginationMeta = z.object({prev_cursor: z.string(), next_cursor: z.string(), total_resources: z.number().int()}); export const getApiApiCustomFieldsResponse = z.object({object: z.string(), uri: z.string(), data: z.array(customField), meta: cursorPaginationMeta}); 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 fields * * GET /api/custom-fields */ export const getApiApiCustomFields = async (args: GetApiApiCustomFieldsArgs, options?: GetApiApiCustomFieldsOptions) => { const {baseUrl = "https://your-domain.gorgias.com", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.object_type != null) query.append("object_type", String(args.object_type)) if (args.search != null) query.append("search", String(args.search)) if (args.archived != null) query.append("archived", String(args.archived)) if (args.order_by != null) query.append("order_by", String(args.order_by)) if (args.cursor != null) query.append("cursor", String(args.cursor)) if (args.limit != null) query.append("limit", String(args.limit)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/custom-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(getApiApiCustomFieldsResponse, await res.json()) };