import {z} from 'zod' export type GetApiCustomerArgs = {fields?: string | undefined, csrId?: string | undefined, sortKey?: string | undefined, sortOrder?: string | undefined, retrievalType: string, retrievalLimit?: string | undefined, objKeys?: string | undefined, customerType?: string | undefined, customerRank?: number | undefined, listEntCustFlag?: number | undefined, searchKey?: string | undefined, searchValue?: string | undefined, rootNodeId?: string | undefined, parentNodeId?: string | undefined, individualId?: string | undefined, reason?: string | undefined}; export type GetApiCustomerOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const objectKey = z.number().int(); export const caseRef = z.object({id: z.string().optional(), href: z.string().optional(), status: z.string().optional(), name: z.string().optional()}); export const timePeriod = z.object({startDateTime: z.string().optional(), endDateTime: z.string().optional()}); export const individualIdentification = z.object({identificationId: z.string().optional(), identificationType: z.string().optional()}); export const characteristic = z.object({name: z.string(), valueType: z.string().optional(), value: z.string()}); export const mediumCharacteristic = z.object({street1: z.string().optional(), street2: z.string().optional(), suburb: z.string().optional(), city: z.string().optional(), postCode: z.string().optional(), stateOrProvince: z.string().optional(), country: z.string().optional(), addressLine1: z.string().optional(), geocode: z.string().optional(), subDoorNumber: z.string().optional(), genericAddress: z.string().optional(), phoneNumber: z.string().optional(), xpos: z.number().optional(), ypos: z.number().optional()}); export const contactMedium = z.object({mediumType: z.string(), characteristic: mediumCharacteristic}); export const partyRef = z.object({"@referredType": z.string(), id: z.string(), href: z.string().optional(), name: z.string().optional(), role: z.string().optional(), individualIdentification: z.array(individualIdentification).optional(), partyCharacteristic: z.array(characteristic).optional(), contactMedium: z.array(contactMedium).optional(), op: z.string().optional()}); export const cycleSpecification = z.object({name: z.string().optional(), preferredCurrency: z.string().optional(), reportLevel: z.string().optional(), suppressBilling: z.string().optional(), suppressCycles: z.string().optional(), suppressUntilDate: z.string().optional(), transferredAccountNumber: z.string().optional(), billEndDate: z.string().optional()}); export const presentationMedia = z.object({name: z.string().optional()}); export const format = z.object({name: z.string().optional(), presentationMedia: presentationMedia.optional(), characteristic: z.array(characteristic).optional()}); export const billStructure = z.object({cycleSpecification: cycleSpecification.optional(), format: z.array(format).optional()}); export const paymentPlan = z.object({paymentMethod: z.string().optional(), paymentLocation: z.string().optional(), autoPay: z.string().optional()}); export const money = z.object({unit: z.string().optional(), value: z.number().optional()}); export const dunningCase = z.object({id: z.string().optional(), name: z.string().optional(), href: z.string().optional(), status: z.string().optional(), currentAmountDue: money.optional()}); export const accountRef = z.object({id: z.string().optional(), name: z.string(), accountNumber: z.string().optional(), accountBalance: z.string().optional(), href: z.string().optional(), accountType: z.string().optional(), creditLimit: z.string().optional(), availableCredit: z.string().optional(), billStructure: billStructure.optional(), paymentPlan: paymentPlan.optional(), dunningCase: dunningCase.optional()}); export const creditProfile = z.object({creditProfileDate: z.string(), creditRiskRating: z.string().optional(), creditLimit: z.string().optional(), creditLimitCurrency: z.string().optional(), expectedRevenue: z.string().optional(), expRevCurrency: z.string().optional(), creditComments: z.string().optional(), taxClass: z.string().optional(), creditScore: z.string().optional(), validFor: timePeriod}); export const paymentMethodRef = z.object({"@type": z.enum(["bankAccountDebit", "bankCard"]).optional(), details: z.object({}).optional(), id: z.string(), href: z.string().optional(), name: z.string().optional()}); export const taxDefinition = z.object({taxType: z.string().optional()}); export const taxExemptionCertificate = z.object({id: z.string().optional(), documentId: z.string().optional(), description: z.string().optional(), validFor: timePeriod.optional(), taxDefinition: z.array(taxDefinition).optional()}); export const treatmentExemption = z.object({id: z.string().optional(), exemption: z.string().optional(), description: z.string().optional()}); export const treatmentSuspension = z.object({suspensionReasonCode: z.string().optional(), suspensionEndDate: z.string().optional(), id: z.string().optional(), suspensionDuration: z.string().optional()}); export const customer = z.object({id: z.string(), href: z.string(), case: caseRef.optional(), name: z.string().optional(), status: z.string().optional(), statusChangeReason: z.string().optional(), defaultDisplayAccount: z.string().optional(), validFor: timePeriod.optional(), engagedParty: z.array(partyRef).optional(), characteristic: z.array(characteristic).optional(), relatedParty: z.array(partyRef).optional(), account: z.array(accountRef).optional(), creditProfile: creditProfile.optional(), contactMedium: z.array(contactMedium).optional(), paymentMethod: z.array(paymentMethodRef).optional(), taxExemptionCertificate: z.array(taxExemptionCertificate).optional(), treatmentExemption: treatmentExemption.optional(), treatmentSuspension: treatmentSuspension.optional()}); export const customerList = z.object({allObjKeys: z.array(objectKey).optional(), totalObjects: z.number().int().optional(), customers: z.array(customer).optional(), warningMessage: z.string().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 }; /** * List or find Customer objects * * GET /customer * * Also accepts auth: OAuth2 */ export const getApiCustomer = async (args: GetApiCustomerArgs, options?: GetApiCustomerOptions) => { const {baseUrl = "https://serverRoot/tmf-api/customerManagement/v4", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json;charset=utf-8") if (args.fields != null) query.append("fields", String(args.fields)) if (args.csrId != null) query.append("csrId", String(args.csrId)) if (args.sortKey != null) query.append("sortKey", String(args.sortKey)) if (args.sortOrder != null) query.append("sortOrder", String(args.sortOrder)) if (args.retrievalType != null) query.append("retrievalType", String(args.retrievalType)) if (args.retrievalLimit != null) query.append("retrievalLimit", String(args.retrievalLimit)) if (args.objKeys != null) query.append("objKeys", String(args.objKeys)) if (args.customerType != null) query.append("customerType", String(args.customerType)) if (args.customerRank != null) query.append("customerRank", String(args.customerRank)) if (args.listEntCustFlag != null) query.append("listEntCustFlag", String(args.listEntCustFlag)) if (args.searchKey != null) query.append("searchKey", String(args.searchKey)) if (args.searchValue != null) query.append("searchValue", String(args.searchValue)) if (args.rootNodeId != null) query.append("rootNodeId", String(args.rootNodeId)) if (args.parentNodeId != null) query.append("parentNodeId", String(args.parentNodeId)) if (args.individualId != null) query.append("individualId", String(args.individualId)) if (args.reason != null) query.append("reason", String(args.reason)) if (ApiKeyAuth !== undefined) headers.set("X-API-Key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/customer${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(customerList, await res.json()) };