import {z} from 'zod' export type GetApiApiJobsArgs = {cursor?: string | undefined, limit?: number | undefined, order_by?: ('created_datetime:asc' | 'created_datetime:desc') | undefined, status?: ('cancel_requested' | 'canceled' | 'done' | 'errored' | 'fatal_errored' | 'pending' | 'running' | 'scheduled' | null) | undefined, type?: ('applyMacro' | 'deleteTicket' | 'exportTicket' | 'importMacro' | 'exportMacro' | 'updateTicket' | 'exportTicketDrilldown' | 'exportConvertCampaignSalesDrilldown' | null) | undefined}; export type GetApiApiJobsOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const job = z.object({id: z.number().int().optional(), cancel_requested_datetime: z.string().nullable().optional(), cancelled_datetime: z.string().nullable().optional(), created_datetime: z.string().nullable().optional(), ended_datetime: z.string().nullable().optional(), failed_datetime: z.string().nullable().optional(), info: z.object({}).optional(), locked_datetime: z.string().nullable().optional(), meta: z.object({}).nullable().optional(), params: z.object({apply_and_close: z.boolean().optional(), end_datetime: z.string().nullable().optional(), macro_id: z.number().int().optional(), start_datetime: z.string().nullable().optional(), ticket_ids: z.array(z.number().int()).optional(), url: z.string().optional(), updates: z.object({}).optional(), view: z.object({}).optional(), view_id: z.number().int().optional(), context: z.object({}).optional()}).optional(), scheduled_datetime: z.string().nullable().optional(), started_datetime: z.string().nullable().optional(), status: z.enum(["cancel_requested", "canceled", "done", "errored", "fatal_errored", "pending", "running", "scheduled"]).optional(), type: z.enum(["applyMacro", "deleteTicket", "exportTicket", "importMacro", "exportMacro", "updateTicket", "exportTicketDrilldown", "exportConvertCampaignSalesDrilldown"]).optional(), user_id: z.number().int().optional(), uri: z.string().optional()}); export const getApiApiJobsResponse = z.object({data: z.array(job), meta: z.object({next_cursor: z.string().optional(), prev_cursor: z.string().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 jobs * * GET /api/jobs */ export const getApiApiJobs = async (args: GetApiApiJobsArgs, options?: GetApiApiJobsOptions) => { 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.limit != null) query.append("limit", String(args.limit)) if (args.order_by != null) query.append("order_by", String(args.order_by)) if (args.status != null) query.append("status", String(args.status)) if (args.type != null) query.append("type", String(args.type)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/jobs${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(getApiApiJobsResponse, await res.json()) };