import {z} from 'zod' export type GetApi10BudgetsBudgetIdArgs = {budgetId: number, includeFields?: (Array<'manualRevenueRecognitionConfigs' | 'milestoneRevenueRecognitionConfigs'>) | undefined, includeAllFields?: boolean | undefined}; export type GetApi10BudgetsBudgetIdOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const budgetStatusPublicResponse = z.object({value: z.number().int().gte(1).optional(), label: z.string().optional()}); export const projectRateCardPublicResponse = z.object({rateCardId: z.number().int().optional(), rateCardName: z.string().optional()}); export const budgetTimeAndMaterialFinancialsPublicResponse = z.object({rateCard: projectRateCardPublicResponse.optional()}); export const subscriptionFinancialsPublicResponse = z.object({subscriptionFrequency: z.enum(["MONTHLY", "QUARTERLY", "YEARLY", "HALF_YEARLY"]).optional(), subscriptionStartDate: z.string().optional(), periodMinutes: z.number().int().gte(1).optional(), periodBudget: z.number().optional(), noOfPeriods: z.number().int().gte(1).optional()}); export const budgetFinancialsMetrics = z.object({actualRevenue: z.number().optional(), estimatedRevenue: z.number().optional(), actualRevenueInAccountCurrency: z.number().optional(), estimatedRevenueInAccountCurrency: z.number().optional(), actualTimeCost: z.number().optional(), estimatedTimeCost: z.number().optional(), actualTimeCostInAccountCurrency: z.number().optional(), estimatedTimeCostInAccountCurrency: z.number().optional(), actualExpenseCost: z.number().optional(), estimatedExpenseCost: z.number().optional(), actualExpenseCostInAccountCurrency: z.number().optional(), estimatedExpenseCostInAccountCurrency: z.number().optional(), actualCost: z.number().optional(), estimatedCost: z.number().optional(), actualCostInAccountCurrency: z.number().optional(), estimatedCostInAccountCurrency: z.number().optional(), trackedMinutes: z.number().optional(), remainingMinutes: z.number().optional(), allocatedMinutes: z.number().optional(), billableAllocatedMinutes: z.number().optional(), nonBillableAllocatedMinutes: z.number().optional(), billableTrackedMinutes: z.number().optional(), nonBillableTrackedMinutes: z.number().optional(), actualProfit: z.number().optional(), estimatedProfit: z.number().optional(), actualProfitInAccountCurrency: z.number().optional(), estimatedProfitInAccountCurrency: z.number().optional(), actualProfitMargin: z.number().optional(), estimatedProfitMargin: z.number().optional(), actualProfitMarginInAccountCurrency: z.number().optional(), estimatedProfitMarginInAccountCurrency: z.number().optional(), percentageBudgetedHoursConsumed: z.number().optional(), percentageBudgetConsumed: z.number().optional(), estimateAtCompletion: z.number().optional(), estimationToCompletionInHours: z.number().optional()}); export const budgetManualRevenueRecognitionConfigPublicAPIResponseEntity = z.object({manualRevenueRecognitionConfigId: z.number().int().optional(), recognitionDate: z.string().optional(), recognisedRevenue: z.number().optional(), recognisedPercentage: z.number().optional()}); export const budgetMilestoneRevenueRecognitionConfigPublicAPIResponseEntity = z.object({milestoneRevenueRecognitionConfigId: z.number().int().optional(), sourceType: z.enum(["TASK", "TASK"]).optional(), sourceId: z.number().int().optional(), recognisedRevenue: z.number().optional(), recognisedPercentage: z.number().optional()}); export const projectVendorUserPublicAPI = z.object({emailId: z.string().optional(), userId: z.number().int().optional(), firstName: z.string().optional(), lastName: z.string().optional()}); export const budgetFieldPublicResponseEntity = z.object({fieldId: z.number().int().gte(1).optional(), fieldLabel: z.string().optional(), fieldValue: z.object({}).optional(), fieldValueLabel: z.string().optional()}); export const budgetPublicAPIResponseEntity = z.object({budgetId: z.number().int().gte(1).optional(), projectId: z.number().int().gte(1).optional(), projectName: z.string().optional(), budgetName: z.string().optional(), startDate: z.string().optional(), endDate: z.string().optional(), status: budgetStatusPublicResponse.optional(), currency: z.enum(["AFN", "ALL", "DZD", "ARS", "AMD", "AUD", "AZN", "BHD", "BDT", "BYN", "BZD", "BOB", "BAM", "BWP", "BRL", "GBP", "BND", "BGN", "BIF", "KHR", "CAD", "CVE", "XAF", "CLP", "CNY", "COP", "KMF", "CDF", "CRC", "HRK", "CZK", "DKK", "DJF", "DOP", "EGP", "ERN", "EEK", "ETB", "EUR", "GEL", "GHS", "GTQ", "GNF", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "LVL", "LBP", "LYD", "LTL", "MOP", "MKD", "MGA", "MYR", "MUR", "MXN", "MDL", "MAD", "MZN", "MMK", "NAD", "NPR", "TWD", "NZD", "NIO", "NGN", "NOK", "OMR", "PKR", "PAB", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SAR", "RSD", "SGD", "SOS", "ZAR", "KRW", "LKR", "SDG", "SEK", "CHF", "SYP", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "USD", "UGX", "UAH", "AED", "UYU", "UZS", "VEF", "VND", "XOF", "YER", "ZMK", "ZWL"]).optional(), billingType: z.enum(["FIXED_FEE", "TIME_AND_MATERIAL", "SUBSCRIPTION", "NON_BILLABLE"]).optional(), revenueRecognitionType: z.string().optional(), customRevenueRecognitionConfigId: z.number().int().optional(), budgetAmount: z.number().optional(), budgetHours: z.number().optional(), timeAndMaterialContract: budgetTimeAndMaterialFinancialsPublicResponse.optional(), subscriptionContract: subscriptionFinancialsPublicResponse.optional(), budgetFinancialsMetrics: budgetFinancialsMetrics.optional(), manualRevenueRecognitionConfigs: z.array(budgetManualRevenueRecognitionConfigPublicAPIResponseEntity).optional(), milestoneRevenueRecognitionConfigs: z.array(budgetMilestoneRevenueRecognitionConfigPublicAPIResponseEntity).optional(), createdAt: z.number().int().optional(), updatedAt: z.number().int().optional(), createdBy: projectVendorUserPublicAPI.optional(), updatedBy: projectVendorUserPublicAPI.optional(), fields: z.array(budgetFieldPublicResponseEntity).optional(), isDefault: 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 }; /** * Get budget by Id * * GET /1.0/budgets/{budgetId} */ export const getApi10BudgetsBudgetId = async (args: GetApi10BudgetsBudgetIdArgs, options?: GetApi10BudgetsBudgetIdOptions) => { const {baseUrl = "https://api.rocketlane.com/api", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.includeFields != null) query.append("includeFields", args.includeFields.join(',')) if (args.includeAllFields != null) query.append("includeAllFields", String(args.includeAllFields)) if (apiKey !== undefined) headers.set("api-key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/1.0/budgets/${encodeURIComponent(String(args.budgetId))}${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(budgetPublicAPIResponseEntity, await res.json()) };