import {z} from 'zod' export type GetApiOrganisationsPillarTwoOverseasReturnNotificationArgs = {accountingPeriodFrom: string, accountingPeriodTo: string, Authorization: string, 'X-Pillar2-Id': string, Accept?: string | undefined}; export type GetApiOrganisationsPillarTwoOverseasReturnNotificationOptions = {baseUrl?: string | undefined, userRestricted?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiOrganisationsPillarTwoOverseasReturnNotificationResponse = z.object({processingDate: z.string(), accountingPeriodFrom: z.string(), accountingPeriodTo: z.string(), filedDateGIR: z.string(), countryGIR: z.string(), reportingEntityName: z.string(), TIN: z.string(), issuingCountryTIN: z.string()}); 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 }; /** * Retrieve Overseas Return Notification * * GET /organisations/pillar-two/overseas-return-notification */ export const getApiOrganisationsPillarTwoOverseasReturnNotification = async (args: GetApiOrganisationsPillarTwoOverseasReturnNotificationArgs, options?: GetApiOrganisationsPillarTwoOverseasReturnNotificationOptions) => { 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/json") if (args.accountingPeriodFrom != null) query.append("accountingPeriodFrom", String(args.accountingPeriodFrom)) if (args.accountingPeriodTo != null) query.append("accountingPeriodTo", String(args.accountingPeriodTo)) if (args.Authorization != null) headers.set("Authorization", String(args.Authorization)) if (args['X-Pillar2-Id'] != null) headers.set("X-Pillar2-Id", String(args['X-Pillar2-Id'])) if (args.Accept != null) headers.set("Accept", String(args.Accept)) if (userRestricted !== undefined) headers.set('authorization', `Bearer ${userRestricted}`) const url = `${baseUrl.replace(/\/+$/, '')}/organisations/pillar-two/overseas-return-notification${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(getApiOrganisationsPillarTwoOverseasReturnNotificationResponse, await res.json()) };