import {z} from 'zod' export type GetApiApiUsersArgs = {cursor?: string | undefined, external_id?: string | undefined, email?: string | undefined, limit?: number | undefined, order_by?: ('created_datetime:asc' | 'created_datetime:desc' | 'name:asc' | 'name:desc' | 'email:asc' | 'email:desc' | 'role.name:asc' | 'role.name:desc') | undefined, roles?: (Array<'admin' | 'agent' | 'basic-agent' | 'bot' | 'internal-agent' | 'lite-agent' | 'observer-agent'>) | undefined, search?: string | undefined, available_first?: boolean | undefined}; export type GetApiApiUsersOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const user = z.object({id: z.number().int().optional(), active: z.boolean().optional(), bio: z.string().optional(), created_datetime: z.string().optional(), country: z.string().optional(), deactivated_datetime: z.string().optional(), email: z.string().optional(), external_id: z.string().optional(), firstname: z.string().optional(), lastname: z.string().optional(), language: z.string().optional(), meta: z.object({sso: z.enum(["google", "office365"]).nullable().optional(), profile_picture_url: z.string().nullable().optional()}).optional(), name: z.string().optional(), role: z.object({name: z.enum(["admin", "agent", "basic-agent", "bot", "internal-agent", "lite-agent", "observer-agent"]).optional()}).optional(), timezone: z.string().optional(), updated_datetime: z.string().optional(), client_id: z.string().optional()}); export const getApiApiUsersResponse = z.array(user); 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 users * * GET /api/users */ export const getApiApiUsers = async (args: GetApiApiUsersArgs, options?: GetApiApiUsersOptions) => { 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.cursor != null) query.append("cursor", String(args.cursor)) if (args.external_id != null) query.append("external_id", String(args.external_id)) if (args.email != null) query.append("email", String(args.email)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.order_by != null) query.append("order_by", String(args.order_by)) for (const item of args.roles ?? []) query.append("roles", String(item)) if (args.search != null) query.append("search", String(args.search)) if (args.available_first != null) query.append("available_first", String(args.available_first)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/users${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(getApiApiUsersResponse, await res.json()) };