import {z} from 'zod' export type GetApiV2BillingAgreementsIdArgs = {id: number}; export type GetApiV2BillingAgreementsIdOptions = {baseUrl: string, oauth2?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiV2BillingAgreementsIdResponse = z.object({id: z.number().int().optional(), name: z.string().optional(), description: z.string().nullable().optional(), invoiceGenerationType: z.enum(["AUTOMATIC", "MANUAL", "ONE_OFF"]).optional(), lastBillDate: z.number().nullable().optional(), nextBillDate: z.string().nullable().optional(), nextBillingPeriodStartDate: z.string().nullable().optional(), lastPeriodStartDate: z.string().nullable().optional(), lastPeriodEndDate: z.string().nullable().optional(), content: z.object({interval: z.string().nullable().optional(), billDate: z.string().nullable().optional(), startDate: z.string().optional(), endDate: z.string().nullable().optional(), businessHours: z.object({twentyFourSeven: z.boolean().optional(), days: z.array(z.object({day: z.enum(["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]).optional(), startHour: z.number().int().gte(0).lte(86399).optional(), endHour: z.number().int().gte(0).lte(86399).optional(), allDayClosed: z.boolean().optional()})).optional()}).optional()}).optional(), contact: z.object({uid: z.string().optional(), id: z.number().int().optional(), clientId: z.number().int().nullable().optional(), clientName: z.string().nullable().optional(), firstName: z.string().nullable().optional(), lastName: z.string().nullable().optional(), email: z.string().optional(), deleted: z.boolean().optional(), userType: z.enum(["TECHNICIAN", "END_USER", "CONTACT"]).optional(), enabled: z.boolean().optional(), ninjaAdmin: z.boolean().optional(), sysadmin: z.boolean().optional()}).nullable().optional(), taxRate: z.object({id: z.number().int().optional(), name: z.string().optional(), description: z.string().nullable().optional(), taxRate: z.number().optional()}).nullable().optional(), client: z.object({id: z.number().int().optional(), name: z.string().optional(), deleted: z.boolean()}).optional(), externalTax: z.object({id: z.string().optional(), name: z.string().optional()}).optional(), createTime: z.number().optional(), updateTime: z.number().optional(), timeDefault: z.boolean().optional(), businessHoursSource: z.enum(["CUSTOM", "TICKETING"]).optional(), dueDaysSource: z.enum(["CUSTOM", "INHERIT_FROM_CONFIGURATION"]).optional(), dueDays: z.number().int().optional(), allowOnlineCreditCardPayments: z.boolean().optional(), allowOnlineAchPayments: z.boolean().optional(), invoiceNote: z.string().optional(), billEmails: z.array(z.string()).optional(), billCcEmails: z.array(z.string()).optional(), billBccEmails: z.array(z.string()).optional(), ticketBillingSettings: z.object({billTicketInAnyStatus: z.boolean().optional(), condition: z.object({operator: z.string().optional(), value: z.string().optional(), metadata: z.array(z.object({id: z.number().int().optional(), name: z.string().optional()}).nullable()).nullable().optional()}).nullable().optional()}).nullable().optional(), multiMatchEndUsers: z.boolean().optional(), multiMatchDevices: z.boolean().optional(), products: z.array(z.object({id: z.number().int().optional(), productId: z.number().int().optional(), name: z.string().optional(), description: z.string().optional(), quantityType: z.enum(["MANUAL", "DEVICE_COUNTS", "TIME_ENTRIES", "END_USER_COUNTS", "BACKUP_STORAGE_COUNTS", "SOFTWARE_LICENSE"]).optional(), content: z.record(z.string(), z.unknown()).optional(), order: z.number().int().optional(), productUserRole: z.object({allowAllTechnicians: z.boolean().optional(), userRoles: z.array(z.object({id: z.number().int().optional(), name: z.string().optional()})).optional()}).optional(), integrationSettings: z.record(z.string(), z.unknown()).optional(), accountId: z.number().int().optional(), group: z.boolean().optional(), taxId: z.number().int().optional(), inheritTaxFromAgreement: z.boolean().optional()}).nullable()).nullable().optional(), deviceCountsProducts: z.array(z.object({id: z.number().int().optional(), productId: z.number().int().optional(), name: z.string().optional(), description: z.string().optional(), quantityType: z.enum(["MANUAL", "DEVICE_COUNTS", "TIME_ENTRIES", "END_USER_COUNTS", "BACKUP_STORAGE_COUNTS", "SOFTWARE_LICENSE"]).optional(), content: z.record(z.string(), z.unknown()).optional(), order: z.number().int().optional(), productUserRole: z.object({allowAllTechnicians: z.boolean().optional(), userRoles: z.array(z.object({id: z.number().int().optional(), name: z.string().optional()})).optional()}).optional(), integrationSettings: z.record(z.string(), z.unknown()).optional(), accountId: z.number().int().optional(), group: z.boolean().optional(), taxId: z.number().int().optional(), inheritTaxFromAgreement: z.boolean().optional()}).nullable()).nullable().optional(), timeEntriesProducts: z.array(z.object({id: z.number().int().optional(), productId: z.number().int().optional(), name: z.string().optional(), description: z.string().optional(), quantityType: z.enum(["MANUAL", "DEVICE_COUNTS", "TIME_ENTRIES", "END_USER_COUNTS", "BACKUP_STORAGE_COUNTS", "SOFTWARE_LICENSE"]).optional(), content: z.record(z.string(), z.unknown()).optional(), order: z.number().int().optional(), productUserRole: z.object({allowAllTechnicians: z.boolean().optional(), userRoles: z.array(z.object({id: z.number().int().optional(), name: z.string().optional()})).optional()}).optional(), integrationSettings: z.record(z.string(), z.unknown()).optional(), accountId: z.number().int().optional(), group: z.boolean().optional(), taxId: z.number().int().optional(), inheritTaxFromAgreement: z.boolean().optional()}).nullable()).nullable().optional(), endUserCountsProducts: z.array(z.object({id: z.number().int().optional(), productId: z.number().int().optional(), name: z.string().optional(), description: z.string().optional(), quantityType: z.enum(["MANUAL", "DEVICE_COUNTS", "TIME_ENTRIES", "END_USER_COUNTS", "BACKUP_STORAGE_COUNTS", "SOFTWARE_LICENSE"]).optional(), content: z.record(z.string(), z.unknown()).optional(), order: z.number().int().optional(), productUserRole: z.object({allowAllTechnicians: z.boolean().optional(), userRoles: z.array(z.object({id: z.number().int().optional(), name: z.string().optional()})).optional()}).optional(), integrationSettings: z.record(z.string(), z.unknown()).optional(), accountId: z.number().int().optional(), group: z.boolean().optional(), taxId: z.number().int().optional(), inheritTaxFromAgreement: z.boolean().optional()}).nullable()).nullable().optional(), backupStorageCountsProducts: z.array(z.object({id: z.number().int().optional(), productId: z.number().int().optional(), name: z.string().optional(), description: z.string().optional(), quantityType: z.enum(["MANUAL", "DEVICE_COUNTS", "TIME_ENTRIES", "END_USER_COUNTS", "BACKUP_STORAGE_COUNTS", "SOFTWARE_LICENSE"]).optional(), content: z.record(z.string(), z.unknown()).optional(), order: z.number().int().optional(), productUserRole: z.object({allowAllTechnicians: z.boolean().optional(), userRoles: z.array(z.object({id: z.number().int().optional(), name: z.string().optional()})).optional()}).optional(), integrationSettings: z.record(z.string(), z.unknown()).optional(), accountId: z.number().int().optional(), group: z.boolean().optional(), taxId: z.number().int().optional(), inheritTaxFromAgreement: z.boolean().optional()}).nullable()).nullable().optional(), softwareLicenseProducts: z.array(z.object({id: z.number().int().optional(), productId: z.number().int().optional(), name: z.string().optional(), description: z.string().optional(), quantityType: z.enum(["MANUAL", "DEVICE_COUNTS", "TIME_ENTRIES", "END_USER_COUNTS", "BACKUP_STORAGE_COUNTS", "SOFTWARE_LICENSE"]).optional(), content: z.record(z.string(), z.unknown()).optional(), order: z.number().int().optional(), productUserRole: z.object({allowAllTechnicians: z.boolean().optional(), userRoles: z.array(z.object({id: z.number().int().optional(), name: z.string().optional()})).optional()}).optional(), integrationSettings: z.record(z.string(), z.unknown()).optional(), accountId: z.number().int().optional(), group: z.boolean().optional(), taxId: z.number().int().optional(), inheritTaxFromAgreement: z.boolean().optional()}).nullable()).nullable().optional(), multiMatchDeviceBackups: z.boolean().optional(), displayIncludedTimeOnInvoices: z.boolean().optional(), taxId: z.number().int().optional(), autoApproveInvoice: z.boolean().optional(), autoCompleteInvoice: z.boolean().optional(), quickBooks: z.object({externalTax: z.object({id: z.string().optional(), name: z.string().optional()}).optional(), allowOnlineCreditCardPayments: z.boolean().optional(), allowOnlineAchPayments: z.boolean().optional()}).optional(), xero: z.object({externalTax: z.object({id: z.string().optional(), name: z.string().optional()}).optional(), brandingTheme: z.object({id: z.string().optional(), name: z.string().optional()}).nullable().optional(), taxlessItemsExternalTax: z.object({id: z.string().optional(), name: z.string().optional()}).nullable().optional(), newInvoiceStatus: z.enum(["DRAFT", "SUBMITTED", "AUTHORISED"]).optional()}).optional(), archived: z.boolean().optional(), active: z.boolean().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 }; /** * Retrieves an agreement given its ID. * * GET /v2/billing/agreements/{id} * * Also accepts auth: sessionKey */ export const getApiV2BillingAgreementsId = async (args: GetApiV2BillingAgreementsIdArgs, options: GetApiV2BillingAgreementsIdOptions) => { const {baseUrl, fetch: fetchFn = fetch, oauth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (oauth2 !== undefined) headers.set('authorization', `Bearer ${oauth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/v2/billing/agreements/${encodeURIComponent(String(args.id))}${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(getApiV2BillingAgreementsIdResponse, await res.json()) };