import {z} from 'zod' export type GetApiV1OrgOrgIdCompReviewCompReviewIdInCycleArgs = {orgId: string, compReviewId: string, scenariosOnly?: boolean | undefined, proposalOnly?: boolean | undefined, reviewsOnly?: boolean | undefined, columnsOnly?: boolean | undefined, isPreview?: boolean | undefined, jobId?: string | undefined, includeAllRequests?: boolean | undefined, includeFeatures?: boolean | undefined}; export type GetApiV1OrgOrgIdCompReviewCompReviewIdInCycleOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const approvalGroupApprover = z.object({jobId: z.string(), status: z.enum(["PENDING", "APPROVED", "REJECTED", "SKIPPED"]), commentId: z.string().optional(), reassignCommentId: z.string().optional(), isFallback: z.boolean().optional(), fallbackFor: z.string().optional(), actedByJobId: z.string().optional(), updateAt: z.string().optional()}); export const approvalGroup = z.object({groupId: z.string().optional(), type: z.enum(["REVIEWER", "COLLABORATOR", "FINAL_APPROVER"]), approvers: z.array(approvalGroupApprover), expandExpression: z.string().optional(), minApproversNeeded: z.number().int().optional()}); export const approvalChainStageOverride = z.object({stageOverrideId: z.string(), approvalChainStageId: z.string(), groups: z.array(approvalGroup).optional(), status: z.enum(["CANCELED", "REJECTED", "PENDING", "ACTIVE", "REVIEWED", "APPROVED", "SKIPPED", "SUBMITTED"]), order: z.number().int()}); export const approvalRequestCompReviewResponse = z.object({id: z.string(), status: z.enum(["CANCELED", "REJECTED", "PENDING", "ACTIVE", "REVIEWED", "APPROVED", "SKIPPED", "SUBMITTED"]), parentStatus: z.enum(["CANCELED", "REJECTED", "PENDING", "ACTIVE", "REVIEWED", "APPROVED", "SKIPPED", "SUBMITTED"]).optional(), isFullySubmitted: z.boolean().optional(), entityType: z.enum(["COMP_REVIEW", "SCENARIO", "TIMEOFF"]), entityId: z.string(), approvalChainId: z.string(), stageOverrides: z.array(approvalChainStageOverride), createId: z.string().optional(), createAt: z.string().optional(), updateId: z.string().optional(), updateAt: z.string().optional()}); export const shareAccess = z.object({access: z.enum(["NONE", "LIMITED_READ", "LIMITED_WRITE", "STANDARD_READ", "STANDARD_WRITE", "COMPENSATION_READ", "FULL_READ", "COMP_PLANNING_PARTICIPANT", "COMPENSATION_WRITE", "WRITE", "COMPENSATION_OWNER", "OWNER"]), userId: z.string().optional(), groupId: z.string().optional(), everyone: z.boolean().optional(), fields: z.string().optional()}); export const costImpact = z.object({annual: z.number(), firstMonth: z.string(), months: z.array(z.number()), basis: z.enum(["ANNUALIZED", "PERIOD_TOTAL"])}); export const attribution = z.object({principalUserId: z.string().optional(), agentUserIds: z.array(z.string()).optional(), eventId: z.string().optional(), aiChatId: z.string().optional(), aiToolUseId: z.string().optional(), channel: z.enum(["WEB", "MOBILE", "SLACK", "TEAMS", "MCP"]).optional()}); export const scenarioSharedViewConfig = z.object({customColumnNames: z.array(z.string()).optional(), columnWidths: z.record(z.string(), z.number().int()).optional(), type: z.enum(["ALL_CHANGES_GROUPED", "CREATE", "HIRE", "DELETE", "DEPART", "COMP", "UPDATE", "MOVE"]).optional(), updateId: z.string().optional(), updateAt: z.string().optional()}); export const money = z.object({amount: z.number(), currency: z.string(), places: z.number().int().optional()}); export const scenario = z.object({id: z.string(), orgId: z.string(), name: z.string(), description: z.string().optional(), startDate: z.string(), status: z.enum(["OPEN", "INACTIVE", "MERGED", "DRAFT", "ARCHIVED"]), shareAccess: z.array(shareAccess), cost: costImpact.optional(), changeCount: z.number().int().optional(), changeCounts: z.record(z.string(), z.number().int()).optional(), maxChangeEffectiveDate: z.string().optional(), createId: z.string(), createBehalfId: z.string().optional(), createAttribution: attribution.optional(), createAt: z.string(), updateId: z.string(), updateBehalfId: z.string().optional(), updateAttribution: attribution.optional(), updateAt: z.string(), deleteId: z.string().optional(), deleteBehalfId: z.string().optional(), deleteAttribution: attribution.optional(), deleteAt: z.string().optional(), mergeId: z.string().optional(), mergeAt: z.string().optional(), calcStartAt: z.string().optional(), calcEndAt: z.string().optional(), changeAt: z.string().optional(), changeId: z.string().optional(), type: z.enum(["GENERAL", "COMP", "PROMOTION", "TERMINATE", "CREATE_JOB", "UPDATE_JOB", "BUDGET", "BACKFILL"]).optional(), startDateFixed: z.enum(["FIXED", "TODAY"]), query: z.string().optional(), validJobIdSet: z.array(z.string()).optional(), approvalRequestId: z.string().optional(), entityId: z.string().optional(), entityType: z.enum(["COMP_REVIEW", "ASSESSMENT"]).optional(), sharedViewConfig: z.array(scenarioSharedViewConfig).optional(), budget: money.optional()}); export const inCycleViewFeatures = z.object({isFinalApprover: z.boolean(), isProposer: z.boolean(), isApprover: z.boolean(), isOwner: z.boolean(), isCollaborator: z.boolean(), isRoot: z.boolean().optional()}); export const compReviewWorkbookColumn = z.object({name: z.string(), label: z.string(), color: z.string().optional(), editableFor: z.string(), visibleTo: z.string(), visibleToGroups: z.array(z.string()), visibleToType: z.enum(["EVERYONE", "DEPARTMENT", "TEAM", "LOCATION", "CUSTOM"]), visibleToRoles: inCycleViewFeatures.optional(), editableForRoles: inCycleViewFeatures.optional()}); export const inCycleViewResponse = z.object({reviews: z.array(approvalRequestCompReviewResponse).optional(), proposal: approvalRequestCompReviewResponse.optional(), scenarioMap: z.record(z.string(), scenario).optional(), parentReviewsMap: z.record(z.string(), z.string()).optional(), collaboratingWithJobIds: z.array(z.string()).optional(), visibleColumns: z.array(compReviewWorkbookColumn).optional(), error: z.record(z.string(), z.string()).optional(), features: inCycleViewFeatures.optional(), canViewImpactDashboard: 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 an overview for a given user in an in-cycle comp-review * * GET /v1/org/{orgId}/comp-review/{compReviewId}/in-cycle */ export const getApiV1OrgOrgIdCompReviewCompReviewIdInCycle = async (args: GetApiV1OrgOrgIdCompReviewCompReviewIdInCycleArgs, options?: GetApiV1OrgOrgIdCompReviewCompReviewIdInCycleOptions) => { const {baseUrl = "https://localhost", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.scenariosOnly != null) query.append("scenariosOnly", String(args.scenariosOnly)) if (args.proposalOnly != null) query.append("proposalOnly", String(args.proposalOnly)) if (args.reviewsOnly != null) query.append("reviewsOnly", String(args.reviewsOnly)) if (args.columnsOnly != null) query.append("columnsOnly", String(args.columnsOnly)) if (args.isPreview != null) query.append("isPreview", String(args.isPreview)) if (args.jobId != null) query.append("jobId", String(args.jobId)) if (args.includeAllRequests != null) query.append("includeAllRequests", String(args.includeAllRequests)) if (args.includeFeatures != null) query.append("includeFeatures", String(args.includeFeatures)) const url = `${baseUrl.replace(/\/+$/, '')}/v1/org/${encodeURIComponent(String(args.orgId))}/comp-review/${encodeURIComponent(String(args.compReviewId))}/in-cycle${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(inCycleViewResponse, await res.json()) };