import {z} from 'zod' export type ViewCategory = 'system' | 'user'; export type GetApiApiViewsArgs = {order_by?: ('created_datetime:asc' | 'created_datetime:desc') | undefined, cursor?: string | undefined, limit?: number | undefined, category?: ViewCategory | undefined}; export type GetApiApiViewsOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const viewDecoration = z.object({emoji: z.string().optional()}); export const viewField = z.enum(["id", "details", "tags", "customer", "last_message", "name", "email", "created", "updated", "assignee", "assignee_team", "channel", "closed", "language", "last_received_message", "integrations", "snooze", "status", "subject", "priority"]); export const viewSharedWithTeam = z.object({id: z.number().int(), name: z.string(), decoration: z.object({}).optional()}); export const viewSharedWithUser = z.object({id: z.number().int(), name: z.string(), meta: z.object({}).optional()}); export const viewType = z.enum(["ticket-list", "customer-list"]); export const viewVisibility = z.enum(["public", "shared", "private"]); export const view = z.object({id: z.number().int(), category: z.string().optional(), created_datetime: z.string().optional(), deactivated_datetime: z.string().optional(), decoration: viewDecoration.optional(), fields: z.array(viewField).optional(), filters: z.string().optional(), name: z.string().optional(), order_by: z.string().optional(), order_dir: z.enum(["asc", "desc"]).optional(), search: z.string().optional(), shared_with_teams: z.array(viewSharedWithTeam).optional(), shared_with_users: z.array(viewSharedWithUser).optional(), slug: z.string().optional(), type: viewType.optional(), uri: z.string(), visibility: viewVisibility.optional()}); export const cursorPaginationMeta = z.object({prev_cursor: z.string(), next_cursor: z.string(), total_resources: z.number().int()}); export const getApiApiViewsResponse = z.object({object: z.string(), uri: z.string(), data: z.array(view), 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 views * * GET /api/views */ export const getApiApiViews = async (args: GetApiApiViewsArgs, options?: GetApiApiViewsOptions) => { 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.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 (args.category != null) query.append("category", String(args.category)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/views${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(getApiApiViewsResponse, await res.json()) };