import {z} from 'zod' export type GetApi10BudgetsArgs = {'budgetId.eq'?: string | undefined, 'budgetId.oneOf'?: string | undefined, 'budgetId.noneOf'?: string | undefined, 'projectId.eq'?: string | undefined, 'projectId.oneOf'?: string | undefined, 'projectId.noneOf'?: string | undefined, 'status.eq'?: string | undefined, 'status.oneOf'?: string | undefined, 'status.noneOf'?: string | undefined, 'billingType.eq'?: string | undefined, 'billingType.oneOf'?: string | undefined, 'billingType.noneOf'?: string | undefined, 'revenueRecognitionType.eq'?: string | undefined, 'revenueRecognitionType.oneOf'?: string | undefined, 'revenueRecognitionType.noneOf'?: string | undefined, 'budgetAmount.eq'?: string | undefined, 'budgetAmount.gt'?: string | undefined, 'budgetAmount.ge'?: string | undefined, 'budgetAmount.lt'?: string | undefined, 'budgetAmount.le'?: string | undefined, 'budgetHours.eq'?: string | undefined, 'budgetHours.gt'?: string | undefined, 'budgetHours.ge'?: string | undefined, 'budgetHours.lt'?: string | undefined, 'budgetHours.le'?: string | undefined, 'budgetName.eq'?: string | undefined, 'budgetName.cn'?: string | undefined, 'budgetName.nc'?: string | undefined, 'startDate.eq'?: string | undefined, 'startDate.gt'?: string | undefined, 'startDate.ge'?: string | undefined, 'startDate.lt'?: string | undefined, 'startDate.le'?: string | undefined, 'endDate.eq'?: string | undefined, 'endDate.gt'?: string | undefined, 'endDate.ge'?: string | undefined, 'endDate.lt'?: string | undefined, 'endDate.le'?: string | undefined, 'createdAt.gt'?: number | undefined, 'createdAt.eq'?: number | undefined, 'createdAt.lt'?: number | undefined, 'createdAt.ge'?: number | undefined, 'createdAt.le'?: number | undefined, 'companyId.eq'?: string | undefined, 'companyId.oneOf'?: string | undefined, 'companyId.noneOf'?: string | undefined, 'isDefault.eq'?: string | undefined, pageSize?: number | undefined, pageToken?: string | undefined, includeFields?: (Array<'manualRevenueRecognitionConfigs' | 'milestoneRevenueRecognitionConfigs'>) | undefined, includeAllFields?: boolean | undefined, sortBy?: ('createdAt' | 'budgetId' | 'projectId' | 'budgetName' | 'budgetHours' | 'budgetAmount' | 'startDate' | 'endDate') | undefined, sortOrder?: ('ASC' | 'DESC') | undefined, match?: ('all' | 'any') | undefined}; export type GetApi10BudgetsOptions = {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 examplePaginationBudgets = z.object({pageSize: z.number().int().optional(), hasMore: z.boolean().optional(), totalRecordCount: z.number().int().optional(), nextPage: z.string().optional(), nextPageToken: z.string().optional()}); export const exampleAPIResponseBudgets = z.object({data: z.array(budgetPublicAPIResponseEntity).optional(), pagination: examplePaginationBudgets.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 all budgets * * GET /1.0/budgets */ export const getApi10Budgets = async (args: GetApi10BudgetsArgs, options?: GetApi10BudgetsOptions) => { 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['budgetId.eq'] != null) query.append("budgetId.eq", String(args['budgetId.eq'])) if (args['budgetId.oneOf'] != null) query.append("budgetId.oneOf", String(args['budgetId.oneOf'])) if (args['budgetId.noneOf'] != null) query.append("budgetId.noneOf", String(args['budgetId.noneOf'])) if (args['projectId.eq'] != null) query.append("projectId.eq", String(args['projectId.eq'])) if (args['projectId.oneOf'] != null) query.append("projectId.oneOf", String(args['projectId.oneOf'])) if (args['projectId.noneOf'] != null) query.append("projectId.noneOf", String(args['projectId.noneOf'])) if (args['status.eq'] != null) query.append("status.eq", String(args['status.eq'])) if (args['status.oneOf'] != null) query.append("status.oneOf", String(args['status.oneOf'])) if (args['status.noneOf'] != null) query.append("status.noneOf", String(args['status.noneOf'])) if (args['billingType.eq'] != null) query.append("billingType.eq", String(args['billingType.eq'])) if (args['billingType.oneOf'] != null) query.append("billingType.oneOf", String(args['billingType.oneOf'])) if (args['billingType.noneOf'] != null) query.append("billingType.noneOf", String(args['billingType.noneOf'])) if (args['revenueRecognitionType.eq'] != null) query.append("revenueRecognitionType.eq", String(args['revenueRecognitionType.eq'])) if (args['revenueRecognitionType.oneOf'] != null) query.append("revenueRecognitionType.oneOf", String(args['revenueRecognitionType.oneOf'])) if (args['revenueRecognitionType.noneOf'] != null) query.append("revenueRecognitionType.noneOf", String(args['revenueRecognitionType.noneOf'])) if (args['budgetAmount.eq'] != null) query.append("budgetAmount.eq", String(args['budgetAmount.eq'])) if (args['budgetAmount.gt'] != null) query.append("budgetAmount.gt", String(args['budgetAmount.gt'])) if (args['budgetAmount.ge'] != null) query.append("budgetAmount.ge", String(args['budgetAmount.ge'])) if (args['budgetAmount.lt'] != null) query.append("budgetAmount.lt", String(args['budgetAmount.lt'])) if (args['budgetAmount.le'] != null) query.append("budgetAmount.le", String(args['budgetAmount.le'])) if (args['budgetHours.eq'] != null) query.append("budgetHours.eq", String(args['budgetHours.eq'])) if (args['budgetHours.gt'] != null) query.append("budgetHours.gt", String(args['budgetHours.gt'])) if (args['budgetHours.ge'] != null) query.append("budgetHours.ge", String(args['budgetHours.ge'])) if (args['budgetHours.lt'] != null) query.append("budgetHours.lt", String(args['budgetHours.lt'])) if (args['budgetHours.le'] != null) query.append("budgetHours.le", String(args['budgetHours.le'])) if (args['budgetName.eq'] != null) query.append("budgetName.eq", String(args['budgetName.eq'])) if (args['budgetName.cn'] != null) query.append("budgetName.cn", String(args['budgetName.cn'])) if (args['budgetName.nc'] != null) query.append("budgetName.nc", String(args['budgetName.nc'])) if (args['startDate.eq'] != null) query.append("startDate.eq", String(args['startDate.eq'])) if (args['startDate.gt'] != null) query.append("startDate.gt", String(args['startDate.gt'])) if (args['startDate.ge'] != null) query.append("startDate.ge", String(args['startDate.ge'])) if (args['startDate.lt'] != null) query.append("startDate.lt", String(args['startDate.lt'])) if (args['startDate.le'] != null) query.append("startDate.le", String(args['startDate.le'])) if (args['endDate.eq'] != null) query.append("endDate.eq", String(args['endDate.eq'])) if (args['endDate.gt'] != null) query.append("endDate.gt", String(args['endDate.gt'])) if (args['endDate.ge'] != null) query.append("endDate.ge", String(args['endDate.ge'])) if (args['endDate.lt'] != null) query.append("endDate.lt", String(args['endDate.lt'])) if (args['endDate.le'] != null) query.append("endDate.le", String(args['endDate.le'])) if (args['createdAt.gt'] != null) query.append("createdAt.gt", String(args['createdAt.gt'])) if (args['createdAt.eq'] != null) query.append("createdAt.eq", String(args['createdAt.eq'])) if (args['createdAt.lt'] != null) query.append("createdAt.lt", String(args['createdAt.lt'])) if (args['createdAt.ge'] != null) query.append("createdAt.ge", String(args['createdAt.ge'])) if (args['createdAt.le'] != null) query.append("createdAt.le", String(args['createdAt.le'])) if (args['companyId.eq'] != null) query.append("companyId.eq", String(args['companyId.eq'])) if (args['companyId.oneOf'] != null) query.append("companyId.oneOf", String(args['companyId.oneOf'])) if (args['companyId.noneOf'] != null) query.append("companyId.noneOf", String(args['companyId.noneOf'])) if (args['isDefault.eq'] != null) query.append("isDefault.eq", String(args['isDefault.eq'])) if (args.pageSize != null) query.append("pageSize", String(args.pageSize)) if (args.pageToken != null) query.append("pageToken", String(args.pageToken)) if (args.includeFields != null) query.append("includeFields", args.includeFields.join(',')) if (args.includeAllFields != null) query.append("includeAllFields", String(args.includeAllFields)) if (args.sortBy != null) query.append("sortBy", String(args.sortBy)) if (args.sortOrder != null) query.append("sortOrder", String(args.sortOrder)) if (args.match != null) query.append("match", String(args.match)) if (apiKey !== undefined) headers.set("api-key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/1.0/budgets${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(exampleAPIResponseBudgets, await res.json()) };