import {z} from 'zod' export type GetApi10KbTagDefinitionsArgs = {audit?: ('FULL' | 'MINIMAL' | 'NONE') | undefined}; export type GetApi10KbTagDefinitionsOptions = {baseUrl: string, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const entity = z.object({id: z.string().optional(), updatedDate: z.string().optional(), createdDate: z.string().optional()}); export const auditLog = z.object({changeType: z.string().optional(), changeDate: z.string().optional(), objectType: z.enum(["ACCOUNT", "ACCOUNT_EMAIL", "BLOCKING_STATES", "BUNDLE", "CUSTOM_FIELD", "INVOICE", "PAYMENT", "TRANSACTION", "INVOICE_ITEM", "INVOICE_PAYMENT", "SUBSCRIPTION", "SUBSCRIPTION_EVENT", "SERVICE_BROADCAST", "PAYMENT_ATTEMPT", "PAYMENT_METHOD", "TAG", "TAG_DEFINITION", "TENANT", "TENANT_KVS"]).optional(), objectId: z.string().optional(), changedBy: z.string().optional(), reasonCode: z.string().optional(), comments: z.string().optional(), userToken: z.string().optional(), history: entity.optional()}); export const tagDefinition = z.object({id: z.string().optional(), isControlTag: z.boolean().optional(), name: z.string(), description: z.string(), applicableObjectTypes: z.array(z.enum(["ACCOUNT", "ACCOUNT_EMAIL", "BLOCKING_STATES", "BUNDLE", "CUSTOM_FIELD", "INVOICE", "PAYMENT", "TRANSACTION", "INVOICE_ITEM", "INVOICE_PAYMENT", "SUBSCRIPTION", "SUBSCRIPTION_EVENT", "SERVICE_BROADCAST", "PAYMENT_ATTEMPT", "PAYMENT_METHOD", "TAG", "TAG_DEFINITION", "TENANT", "TENANT_KVS"])).optional(), auditLogs: z.array(auditLog).optional()}); export const getApi10KbTagDefinitionsResponse = z.array(tagDefinition); 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 }; /** * List tag definitions * * GET /1.0/kb/tagDefinitions * * Also accepts auth: Killbill_Api_Key, Killbill_Api_Secret */ export const getApi10KbTagDefinitions = async (args: GetApi10KbTagDefinitionsArgs, options: GetApi10KbTagDefinitionsOptions) => { const {baseUrl, fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.audit != null) query.append("audit", String(args.audit)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/1.0/kb/tagDefinitions${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(getApi10KbTagDefinitionsResponse, await res.json()) };