import {z} from 'zod' export type GetApi10ProjectsArgs = {pageSize?: number | undefined, pageToken?: string | undefined, includeFields?: (Array<'annualizedRecurringRevenue' | 'projectFee' | 'allocatedHours' | 'allocatedMinutes' | 'budgetedHours' | 'percentageBudgetedHoursConsumed' | 'percentageBudgetConsumed' | 'billableHours' | 'billableMinutes' | 'nonBillableHours' | 'nonBillableMinutes' | 'trackedHours' | 'trackedMinutes' | 'progressPercentage' | 'startDateActual' | 'dueDateActual' | 'currentPhase' | 'autoAllocation' | 'sources' | 'inferredProgress' | 'plannedDuration' | 'projectAgeInDays' | 'customersInvited' | 'customersJoined' | 'externalReferenceId' | 'metrics' | 'remainingMinutes' | 'remainingHours'>) | undefined, includeAllFields?: boolean | undefined, sortBy?: ('projectName' | 'startDate' | 'dueDate' | 'startDateActual' | 'dueDateActual' | 'annualizedRecurringRevenue' | 'projectFee') | undefined, sortOrder?: ('ASC' | 'DESC') | undefined, match?: ('all' | 'any') | undefined, 'startDate.gt'?: string | undefined, 'startDate.eq'?: string | undefined, 'startDate.lt'?: string | undefined, 'startDate.ge'?: string | undefined, 'startDate.le'?: string | undefined, 'dueDate.gt'?: string | undefined, 'dueDate.eq'?: string | undefined, 'dueDate.lt'?: string | undefined, 'dueDate.ge'?: string | undefined, 'dueDate.le'?: string | undefined, 'startDateActual.gt'?: string | undefined, 'startDateActual.eq'?: string | undefined, 'startDateActual.lt'?: string | undefined, 'startDateActual.ge'?: string | undefined, 'startDateActual.le'?: string | undefined, 'dueDateActual.gt'?: string | undefined, 'dueDateActual.eq'?: string | undefined, 'dueDateActual.lt'?: string | undefined, 'dueDateActual.ge'?: string | undefined, 'dueDateActual.le'?: string | undefined, 'createdAt.gt'?: number | undefined, 'createdAt.eq'?: number | undefined, 'createdAt.lt'?: number | undefined, 'createdAt.ge'?: number | undefined, 'createdAt.le'?: number | undefined, 'updatedAt.gt'?: number | undefined, 'updatedAt.eq'?: number | undefined, 'updatedAt.lt'?: number | undefined, 'updatedAt.ge'?: number | undefined, 'updatedAt.le'?: number | undefined, 'annualizedRecurringRevenue.eq'?: number | undefined, 'annualizedRecurringRevenue.gt'?: number | undefined, 'annualizedRecurringRevenue.lt'?: number | undefined, 'projectFee.eq'?: number | undefined, 'projectFee.gt'?: number | undefined, 'projectFee.lt'?: number | undefined, 'customerId.eq'?: string | undefined, 'customerId.oneOf'?: string | undefined, 'customerId.noneOf'?: string | undefined, 'teamMemberId.eq'?: string | undefined, 'teamMemberId.oneOf'?: string | undefined, 'teamMemberId.noneOf'?: string | undefined, 'companyId.eq'?: string | undefined, 'companyId.oneOf'?: string | undefined, 'companyId.noneOf'?: string | undefined, 'projectName.eq'?: string | undefined, 'projectName.cn'?: string | undefined, 'projectName.nc'?: string | undefined, 'inferredProgress.eq'?: (Array<'ON_TRACK' | 'AHEAD_OF_TIME' | 'RUNNING_LATE' | 'NONE'>) | undefined, 'contractType.eq'?: (Array<'FIXED_FEE' | 'TIME_AND_MATERIAL' | 'SUBSCRIPTION' | 'NON_BILLABLE'>) | undefined, 'contractType.oneOf'?: (Array<'FIXED_FEE' | 'TIME_AND_MATERIAL' | 'SUBSCRIPTION' | 'NON_BILLABLE'>) | undefined, 'contractType.noneOf'?: (Array<'FIXED_FEE' | 'TIME_AND_MATERIAL' | 'SUBSCRIPTION' | 'NON_BILLABLE'>) | undefined, 'budgetedHours.gt'?: string | undefined, 'budgetedHours.eq'?: string | undefined, 'budgetedHours.lt'?: string | undefined, 'budgetedHours.ge'?: string | undefined, 'allocatedHours.le'?: string | undefined, 'allocatedHours.gt'?: string | undefined, 'allocatedHours.eq'?: string | undefined, 'allocatedHours.lt'?: string | undefined, 'allocatedHours.ge'?: string | undefined, 'customersInvited.gt'?: string | undefined, 'customersInvited.eq'?: string | undefined, 'customersInvited.lt'?: string | undefined, 'customersInvited.ge'?: string | undefined, 'customersInvited.le'?: string | undefined, 'customersJoined.gt'?: string | undefined, 'customersJoined.eq'?: string | undefined, 'customersJoined.lt'?: string | undefined, 'customersJoined.ge'?: string | undefined, 'customersJoined.le'?: string | undefined, 'includeArchive.eq'?: boolean | undefined, 'status.eq'?: string | undefined, 'status.oneOf'?: string | undefined, 'status.noneOf'?: string | undefined, 'externalReferenceId.eq'?: string | undefined}; export type GetApi10ProjectsOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const importPublicAPIResponseEntity = z.object({prefix: z.string().optional(), startDate: z.string().optional(), templateId: z.number().int().optional(), templateName: z.string().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 projectCustomerUserPublicAPI = z.object({emailId: z.string().optional(), userId: z.number().int().optional(), firstName: z.string().optional(), lastName: z.string().optional()}); export const projectCustomerChampionUserPublicAPI = z.object({emailId: z.string().optional(), userId: z.number().int().optional(), firstName: z.string().optional(), lastName: z.string().optional()}); export const projectResponseMembersResponse = z.object({members: z.array(projectVendorUserPublicAPI).optional(), customers: z.array(projectCustomerUserPublicAPI).optional(), customerChampion: projectCustomerChampionUserPublicAPI.optional()}); export const projectPhasePublicLiteAPIResponseEntity = z.object({phaseId: z.number().int().optional(), phaseName: z.string().optional()}); export const projectOwnerUserPublicResponse = z.object({emailId: z.string().optional(), userId: z.number().int().optional(), firstName: z.string().optional(), lastName: z.string().optional()}); export const projectPublicUpdatedByResponse = z.object({emailId: z.string().optional(), userId: z.number().int().optional(), firstName: z.string().optional(), lastName: z.string().optional()}); export const projectPartnerCompanyPublicAPIResponseEntity = z.object({companyId: z.number().int().gte(1).optional(), companyName: z.string().optional(), companyUrl: z.string().optional()}); export const projectPublicCreatedByResponse = z.object({emailId: z.string().optional(), userId: z.number().int().optional(), firstName: z.string().optional(), lastName: z.string().optional()}); export const projectFieldPublicResponseAPIEntity = z.object({fieldId: z.number().int().gte(1).optional(), fieldLabel: z.string().optional(), fieldValue: z.string().optional(), fieldValueLabel: z.string().optional()}); export const customerCompanyProjectPublicResponse = z.object({companyId: z.number().int().gte(1).optional(), companyName: z.string().optional(), companyUrl: z.string().optional()}); export const projectStatusPublicResponse = z.object({value: z.number().int().gte(1).optional(), label: z.string().optional()}); export const fixedFeeFinancialsPublicResponse = z.object({fixedFee: z.number().optional()}); export const projectRateCardPublicResponse = z.object({rateCardId: z.number().int().optional(), rateCardName: z.string().optional()}); export const timeAndMaterialFinancialsPublicResponse = z.object({rateCard: projectRateCardPublicResponse.optional(), projectBudget: z.number().gte(1).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 projectFinancialsMetrics = z.object({actualRevenue: z.number().optional(), estimatedRevenue: z.number().optional(), actualCost: z.number().optional(), estimatedCost: z.number().optional(), actualProfit: z.number().optional(), estimatedProfit: z.number().optional(), actualProfitMargin: z.number().optional(), estimatedProfitMargin: z.number().optional(), estimateAtCompletion: z.number().optional(), estimationToCompletionInHours: z.number().optional()}); export const projectFinancialsPublicResponse = z.object({contractType: z.enum(["FIXED_FEE", "TIME_AND_MATERIAL", "SUBSCRIPTION", "NON_BILLABLE"]).optional(), revenueRecognitionType: z.string().optional(), fixedFeeContract: fixedFeeFinancialsPublicResponse.optional(), timeAndMaterialContract: timeAndMaterialFinancialsPublicResponse.optional(), subscriptionContract: subscriptionFinancialsPublicResponse.optional(), metrics: projectFinancialsMetrics.optional()}); export const projectPublicAPIResponseExampleEntity = z.object({sources: z.array(importPublicAPIResponseEntity).optional(), dueDate: z.string().optional(), autoAllocation: z.boolean().optional(), dueDateActual: z.string().optional(), teamMembers: projectResponseMembersResponse.optional(), createdAt: z.number().int().optional(), archived: z.boolean().optional(), inferredProgress: z.enum(["ON_TRACK", "AHEAD_OF_TIME", "RUNNING_LATE", "NONE"]).optional(), plannedDurationInDays: z.number().int().optional(), currentPhases: z.array(projectPhasePublicLiteAPIResponseEntity).optional(), customersInvited: z.number().int().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(), updatedAt: z.number().int().optional(), owner: projectOwnerUserPublicResponse.optional(), budgetedHours: z.number().optional(), updatedBy: projectPublicUpdatedByResponse.optional(), partnerCompanies: z.array(projectPartnerCompanyPublicAPIResponseEntity).optional(), visibility: z.enum(["EVERYONE", "MEMBERS", "GROUP"]).optional(), annualizedRecurringRevenue: z.number().int().optional(), allocatedHours: z.number().int().optional(), trackedHours: z.number().int().optional(), projectAgeInDays: z.number().int().optional(), createdBy: projectPublicCreatedByResponse.optional(), projectFee: z.number().int().optional(), customersJoined: z.number().int().optional(), progressPercentage: z.number().int().optional(), projectName: z.string().optional(), fields: z.array(projectFieldPublicResponseAPIEntity).optional(), projectId: z.number().int().gte(1).optional(), startDate: z.string().optional(), customer: customerCompanyProjectPublicResponse.optional(), status: projectStatusPublicResponse.optional(), startDateActual: z.string().optional(), percentageBudgetedHoursConsumed: z.number().optional(), percentageBudgetConsumed: z.number().optional(), trackedMinutes: z.number().optional(), allocatedMinutes: z.number().optional(), billableHours: z.number().int().optional(), billableMinutes: z.number().optional(), nonBillableHours: z.number().int().optional(), nonBillableMinutes: z.number().optional(), remainingHours: z.number().int().optional(), remainingMinutes: z.number().int().optional(), externalReferenceId: z.string().optional(), financials: projectFinancialsPublicResponse.optional()}); export const examplePaginationProjects = 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 exampleAPIResponseProjects = z.object({data: z.array(projectPublicAPIResponseExampleEntity).optional(), pagination: examplePaginationProjects.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 projects * * GET /1.0/projects */ export const getApi10Projects = async (args: GetApi10ProjectsArgs, options?: GetApi10ProjectsOptions) => { 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.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 (args['startDate.gt'] != null) query.append("startDate.gt", String(args['startDate.gt'])) if (args['startDate.eq'] != null) query.append("startDate.eq", String(args['startDate.eq'])) if (args['startDate.lt'] != null) query.append("startDate.lt", String(args['startDate.lt'])) if (args['startDate.ge'] != null) query.append("startDate.ge", String(args['startDate.ge'])) if (args['startDate.le'] != null) query.append("startDate.le", String(args['startDate.le'])) if (args['dueDate.gt'] != null) query.append("dueDate.gt", String(args['dueDate.gt'])) if (args['dueDate.eq'] != null) query.append("dueDate.eq", String(args['dueDate.eq'])) if (args['dueDate.lt'] != null) query.append("dueDate.lt", String(args['dueDate.lt'])) if (args['dueDate.ge'] != null) query.append("dueDate.ge", String(args['dueDate.ge'])) if (args['dueDate.le'] != null) query.append("dueDate.le", String(args['dueDate.le'])) if (args['startDateActual.gt'] != null) query.append("startDateActual.gt", String(args['startDateActual.gt'])) if (args['startDateActual.eq'] != null) query.append("startDateActual.eq", String(args['startDateActual.eq'])) if (args['startDateActual.lt'] != null) query.append("startDateActual.lt", String(args['startDateActual.lt'])) if (args['startDateActual.ge'] != null) query.append("startDateActual.ge", String(args['startDateActual.ge'])) if (args['startDateActual.le'] != null) query.append("startDateActual.le", String(args['startDateActual.le'])) if (args['dueDateActual.gt'] != null) query.append("dueDateActual.gt", String(args['dueDateActual.gt'])) if (args['dueDateActual.eq'] != null) query.append("dueDateActual.eq", String(args['dueDateActual.eq'])) if (args['dueDateActual.lt'] != null) query.append("dueDateActual.lt", String(args['dueDateActual.lt'])) if (args['dueDateActual.ge'] != null) query.append("dueDateActual.ge", String(args['dueDateActual.ge'])) if (args['dueDateActual.le'] != null) query.append("dueDateActual.le", String(args['dueDateActual.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['updatedAt.gt'] != null) query.append("updatedAt.gt", String(args['updatedAt.gt'])) if (args['updatedAt.eq'] != null) query.append("updatedAt.eq", String(args['updatedAt.eq'])) if (args['updatedAt.lt'] != null) query.append("updatedAt.lt", String(args['updatedAt.lt'])) if (args['updatedAt.ge'] != null) query.append("updatedAt.ge", String(args['updatedAt.ge'])) if (args['updatedAt.le'] != null) query.append("updatedAt.le", String(args['updatedAt.le'])) if (args['annualizedRecurringRevenue.eq'] != null) query.append("annualizedRecurringRevenue.eq", String(args['annualizedRecurringRevenue.eq'])) if (args['annualizedRecurringRevenue.gt'] != null) query.append("annualizedRecurringRevenue.gt", String(args['annualizedRecurringRevenue.gt'])) if (args['annualizedRecurringRevenue.lt'] != null) query.append("annualizedRecurringRevenue.lt", String(args['annualizedRecurringRevenue.lt'])) if (args['projectFee.eq'] != null) query.append("projectFee.eq", String(args['projectFee.eq'])) if (args['projectFee.gt'] != null) query.append("projectFee.gt", String(args['projectFee.gt'])) if (args['projectFee.lt'] != null) query.append("projectFee.lt", String(args['projectFee.lt'])) if (args['customerId.eq'] != null) query.append("customerId.eq", String(args['customerId.eq'])) if (args['customerId.oneOf'] != null) query.append("customerId.oneOf", String(args['customerId.oneOf'])) if (args['customerId.noneOf'] != null) query.append("customerId.noneOf", String(args['customerId.noneOf'])) if (args['teamMemberId.eq'] != null) query.append("teamMemberId.eq", String(args['teamMemberId.eq'])) if (args['teamMemberId.oneOf'] != null) query.append("teamMemberId.oneOf", String(args['teamMemberId.oneOf'])) if (args['teamMemberId.noneOf'] != null) query.append("teamMemberId.noneOf", String(args['teamMemberId.noneOf'])) 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['projectName.eq'] != null) query.append("projectName.eq", String(args['projectName.eq'])) if (args['projectName.cn'] != null) query.append("projectName.cn", String(args['projectName.cn'])) if (args['projectName.nc'] != null) query.append("projectName.nc", String(args['projectName.nc'])) if (args['inferredProgress.eq'] != null) query.append("inferredProgress.eq", args['inferredProgress.eq'].join(',')) if (args['contractType.eq'] != null) query.append("contractType.eq", args['contractType.eq'].join(',')) if (args['contractType.oneOf'] != null) query.append("contractType.oneOf", args['contractType.oneOf'].join(',')) if (args['contractType.noneOf'] != null) query.append("contractType.noneOf", args['contractType.noneOf'].join(',')) if (args['budgetedHours.gt'] != null) query.append("budgetedHours.gt", String(args['budgetedHours.gt'])) if (args['budgetedHours.eq'] != null) query.append("budgetedHours.eq", String(args['budgetedHours.eq'])) if (args['budgetedHours.lt'] != null) query.append("budgetedHours.lt", String(args['budgetedHours.lt'])) if (args['budgetedHours.ge'] != null) query.append("budgetedHours.ge", String(args['budgetedHours.ge'])) if (args['allocatedHours.le'] != null) query.append("allocatedHours.le", String(args['allocatedHours.le'])) if (args['allocatedHours.gt'] != null) query.append("allocatedHours.gt", String(args['allocatedHours.gt'])) if (args['allocatedHours.eq'] != null) query.append("allocatedHours.eq", String(args['allocatedHours.eq'])) if (args['allocatedHours.lt'] != null) query.append("allocatedHours.lt", String(args['allocatedHours.lt'])) if (args['allocatedHours.ge'] != null) query.append("allocatedHours.ge", String(args['allocatedHours.ge'])) if (args['customersInvited.gt'] != null) query.append("customersInvited.gt", String(args['customersInvited.gt'])) if (args['customersInvited.eq'] != null) query.append("customersInvited.eq", String(args['customersInvited.eq'])) if (args['customersInvited.lt'] != null) query.append("customersInvited.lt", String(args['customersInvited.lt'])) if (args['customersInvited.ge'] != null) query.append("customersInvited.ge", String(args['customersInvited.ge'])) if (args['customersInvited.le'] != null) query.append("customersInvited.le", String(args['customersInvited.le'])) if (args['customersJoined.gt'] != null) query.append("customersJoined.gt", String(args['customersJoined.gt'])) if (args['customersJoined.eq'] != null) query.append("customersJoined.eq", String(args['customersJoined.eq'])) if (args['customersJoined.lt'] != null) query.append("customersJoined.lt", String(args['customersJoined.lt'])) if (args['customersJoined.ge'] != null) query.append("customersJoined.ge", String(args['customersJoined.ge'])) if (args['customersJoined.le'] != null) query.append("customersJoined.le", String(args['customersJoined.le'])) if (args['includeArchive.eq'] != null) query.append("includeArchive.eq", String(args['includeArchive.eq'])) 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['externalReferenceId.eq'] != null) query.append("externalReferenceId.eq", String(args['externalReferenceId.eq'])) if (apiKey !== undefined) headers.set("api-key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/1.0/projects${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(exampleAPIResponseProjects, await res.json()) };