import {z} from 'zod' export type GetApiOrganisationsPillarTwoObligationsAndSubmissionsArgs = {fromDate: string, toDate: string}; export type GetApiOrganisationsPillarTwoObligationsAndSubmissionsOptions = {baseUrl?: string | undefined, userRestricted?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiOrganisationsPillarTwoObligationsAndSubmissionsResponse = z.object({processingDate: z.string(), accountingPeriodDetails: z.array(z.object({startDate: z.string(), endDate: z.string(), dueDate: z.string(), underEnquiry: z.boolean(), obligations: z.array(z.object({obligationType: z.enum(["UKTR", "GIR"]), status: z.enum(["Open", "Fulfilled"]), canAmend: z.boolean(), submissions: z.array(z.object({submissionType: z.enum(["UKTR_CREATE", "UKTR_AMEND", "ORN_CREATE", "ORN_AMEND", "BTN", "GIR_CREATE", "GIR_AMEND", "GIR_DELETE"]), receivedDate: z.string(), country: z.string().nullable().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 }; /** * Retrieve Obligations and Submissions * * GET /organisations/pillar-two/obligations-and-submissions */ export const getApiOrganisationsPillarTwoObligationsAndSubmissions = async (args: GetApiOrganisationsPillarTwoObligationsAndSubmissionsArgs, options?: GetApiOrganisationsPillarTwoObligationsAndSubmissionsOptions) => { 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.fromDate != null) query.append("fromDate", String(args.fromDate)) if (args.toDate != null) query.append("toDate", String(args.toDate)) if (userRestricted !== undefined) headers.set('authorization', `Bearer ${userRestricted}`) const url = `${baseUrl.replace(/\/+$/, '')}/organisations/pillar-two/obligations-and-submissions${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(getApiOrganisationsPillarTwoObligationsAndSubmissionsResponse, await res.json()) };