import {z} from 'zod' export type GetApiCustomsExciseMovementsArgs = {Accept: 'application/vnd.hmrc.1.0+json', ern?: string | undefined, arc?: string | undefined, lrn?: string | undefined, updatedSince?: string | undefined, traderType?: ('consignor' | 'consignee') | undefined}; export type GetApiCustomsExciseMovementsOptions = {baseUrl?: string | undefined, userRestricted?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiCustomsExciseMovementsResponse = z.array(z.object({movementId: z.string(), boxId: z.string().optional(), localReferenceNumber: z.string(), consignorId: z.string(), consigneeId: z.string().optional(), administrativeReferenceCode: z.string().optional(), lastUpdated: 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 }; /** * Get excise movements * * GET /customs/excise/movements */ export const getApiCustomsExciseMovements = async (args: GetApiCustomsExciseMovementsArgs, options?: GetApiCustomsExciseMovementsOptions) => { const {baseUrl = "https://test-api.service.hmrc.gov.uk", fetch: fetchFn = fetch, userRestricted} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/vnd.hmrc.1.0+json") if (args.Accept != null) headers.set("Accept", String(args.Accept)) if (args.ern != null) query.append("ern", String(args.ern)) if (args.arc != null) query.append("arc", String(args.arc)) if (args.lrn != null) query.append("lrn", String(args.lrn)) if (args.updatedSince != null) query.append("updatedSince", String(args.updatedSince)) if (args.traderType != null) query.append("traderType", String(args.traderType)) if (userRestricted !== undefined) headers.set('authorization', `Bearer ${userRestricted}`) const url = `${baseUrl.replace(/\/+$/, '')}/customs/excise/movements${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(getApiCustomsExciseMovementsResponse, await res.json()) };