import {z} from 'zod' export type GetApiCompaniesKyckrIdLiteArgs = {customerReference?: string | undefined}; export type GetApiCompaniesKyckrIdLiteOptions = {baseUrl?: string | undefined, AuthHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const cost = z.object({type: z.enum(["credit", "lite"]).optional(), value: z.number().optional()}); export const activity = z.object({code: z.string().optional(), description: z.string().optional(), classificationScheme: z.enum(["NACE", "NACErev2", "NACErev2.1", "SIC", "SIC07", "NAICS"]).optional(), type: z.enum(["Primary", "Secondary"]).optional()}); export const address = z.object({identifier: z.string().nullable().optional(), type: z.string().min(1).optional(), fullAddress: z.string().min(1).optional(), rawAddressLines: z.array(z.string()).optional(), buildingName: z.string().optional(), streetNumber: z.string().optional(), streetName: z.string().optional(), city: z.string().min(1).optional(), postcode: z.string().min(1).optional(), municipality: z.string().optional(), region: z.string().min(1).optional(), country: z.string().min(1).optional(), isoCode: z.string().optional(), secondaryPostalCode: z.string().optional()}); export const alternativeNames = z.object({name: z.string().optional(), type: z.string().optional()}); export const normalizedDate = z.object({original: z.string().optional(), normalized: z.string().optional()}); export const previousNames = z.object({name: z.string().optional(), startDate: normalizedDate.optional(), endDate: normalizedDate.optional()}); export const identifier = z.object({value: z.string().optional(), type: z.string().optional()}); export const normalizedLegalForm = z.object({original: z.string().optional(), normalized: z.enum(["Private Limited Company", "Public Limited Company", "Limited Partnership", "Limited Liability Partnership", "General Partnership", "Cooperative", "Collective Investment Vehicle", "Association", "Sole Proprietor", "Branch", "Foreign Registered Body", "Government or Public Body", "Foundation", "Trust", "Other"]).optional()}); export const normalizedStatus = z.object({original: z.string().optional(), normalized: z.enum(["Active", "Inactive", "Distressed", "Other"]).optional()}); export const liteProfile = z.object({activity: z.array(activity).optional(), address: address.optional(), companyNumber: z.string().optional(), registrationAuthority: z.string().optional(), registrationAuthorityCode: z.string().optional(), registrationType: z.string().optional(), registrationTypeDetails: z.object({originalCode: z.string().optional(), originalDescription: z.string().optional(), normalizedCode: z.string().optional(), normalizedDescription: z.string().optional()}).optional(), companyName: z.string().optional(), englishName: z.string().optional(), aliases: z.array(alternativeNames).optional(), previousNames: z.array(previousNames).optional(), otherIdentifiers: z.array(identifier).optional(), taxNumber: z.string().optional(), foundationDate: normalizedDate.optional(), registrationDate: normalizedDate.optional(), lastAnnualAccountDate: normalizedDate.optional(), legalForm: normalizedLegalForm.optional(), legalStatus: normalizedStatus.optional(), stateOfIncorporation: z.string().optional(), updatedDate: normalizedDate.optional()}); export const getApiCompaniesKyckrIdLiteResponse = z.object({orderId: z.string().optional(), correlationId: z.string().optional(), customerReference: z.string().optional(), timeStamp: z.string().optional(), details: z.string().optional(), cost: cost.optional(), links: z.object({self: z.string().optional()}).optional(), data: liteProfile.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 }; /** * Lite Profile * * GET /companies/{kyckrId}/lite */ export const getApiCompaniesKyckrIdLite = async (args: GetApiCompaniesKyckrIdLiteArgs, options?: GetApiCompaniesKyckrIdLiteOptions) => { const {baseUrl = "https://api.kyckr.com/v2", fetch: fetchFn = fetch, AuthHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.customerReference != null) query.append("customerReference", String(args.customerReference)) if (AuthHeader !== undefined) headers.set('authorization', `Bearer ${AuthHeader}`) const url = `${baseUrl.replace(/\/+$/, '')}/companies/${encodeURIComponent(String(args.kyckrId))}/lite${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(getApiCompaniesKyckrIdLiteResponse, await res.json()) };