import {z} from 'zod' export type GetApiOrganisationsPillarTwoSetupOrganisationArgs = {Authorization: string, 'X-Pillar2-Id': string, Accept?: string | undefined}; export type GetApiOrganisationsPillarTwoSetupOrganisationOptions = {baseUrl?: string | undefined, userRestricted?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiOrganisationsPillarTwoSetupOrganisationResponse = z.object({pillar2Id: z.string(), organisation: z.object({orgDetails: z.object({domesticOnly: z.boolean(), organisationName: z.string(), registrationDate: z.string()}), accountingPeriod: z.object({startDate: z.string(), endDate: z.string(), underEnquiry: z.boolean().nullable().optional()}), testData: z.object({accountActivityScenario: z.enum(["DTT_CHARGE", "FULLY_PAID_CHARGE", "FULLY_PAID_CHARGE_WITH_SPLIT_PAYMENTS", "REPAYMENT_INTEREST", "DTT_DETERMINATION", "DTT_IIR_UTPR", "ACCRUED_INTEREST", "DTT_IIR_UTPR_INTEREST", "DTT_IIR_UTPR_DETERMINATION", "DTT_IIR_UTPR_DISCOVERY", "DTT_IIR_UTPR_OVERPAID_CLAIM", "UKTR_DTT_UKTR_MTT_LATE_FILING_PENALTY", "ORN_GIR_DTT_UKTR_MTT_LATE_FILING_PENALTY", "POTENTIAL_LOST_REVENUE_PENALTY", "SCHEDULE_36_PENALTY", "RECORD_KEEPING_PENALTY", "REPAYMENT_CREDIT", "INTEREST_REPAYMENT_CREDIT", "COMBINED_REPAYMENT"])}).optional(), lastUpdated: 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 }; /** * Get Test Organisation * * GET /organisations/pillar-two/setup/organisation */ export const getApiOrganisationsPillarTwoSetupOrganisation = async (args: GetApiOrganisationsPillarTwoSetupOrganisationArgs, options?: GetApiOrganisationsPillarTwoSetupOrganisationOptions) => { 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.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/setup/organisation${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(getApiOrganisationsPillarTwoSetupOrganisationResponse, await res.json()) };