import {z} from 'zod' export type GetApiProgressionRunbooksRunbookIdArgs = {runbookId: string}; export type GetApiProgressionRunbooksRunbookIdOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const referenceDataItem = z.object({Id: z.string().optional(), Name: z.string().optional()}); export const runbooksDashboardItemResourceGitReference = z.object({GitCommit: z.string().optional(), GitRef: z.string().optional()}); export const runbooksDashboardItemResource = z.object({CompletedTime: z.string().optional(), Created: z.string().optional(), Duration: z.string().optional(), EnvironmentId: z.string().optional(), ErrorMessage: z.string().optional(), GitReference: runbooksDashboardItemResourceGitReference.optional(), HasPendingInterruptions: z.boolean().optional(), HasPendingPreconditions: z.boolean().optional(), HasWarningsOrErrors: z.boolean().optional(), Id: z.string().optional(), IsCompleted: z.boolean().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), PendingInterruptionTypes: z.array(z.enum(["ManualIntervention", "GuidedFailure", "PullRequestCompletion", "ArgoCDApplicationSync", "KubernetesResourceVerification"])).optional(), PendingPreconditionTypes: z.array(z.string()).optional(), ProjectId: z.string().optional(), QueueTime: z.string().optional(), RunbookId: z.string().optional(), RunbookSnapshotId: z.string().optional(), RunbookSnapshotName: z.string().optional(), RunbookSnapshotNotes: z.string().optional(), RunBy: z.string().optional(), RunByActorType: z.enum(["Unknown", "System", "User", "Agent", "ServiceAccount"]).optional(), RunName: z.string().optional(), StartTime: z.string().optional(), State: z.enum(["Queued", "Executing", "Failed", "Canceled", "TimedOut", "Success", "Cancelling"]).optional(), TaskId: z.string().optional(), TenantId: z.string().optional()}); export const runbooksProgressionResource = z.object({Environments: z.array(referenceDataItem).optional(), Id: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), RunbookRuns: z.record(z.string(), z.array(runbooksDashboardItemResource)).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 the progress of a runbook in the environment lifecycle. * * GET /progression/runbooks/{runbookId} * * Also accepts auth: APIKeyQuery, NugetApiKeyHeader */ export const getApiProgressionRunbooksRunbookId = async (args: GetApiProgressionRunbooksRunbookIdArgs, options?: GetApiProgressionRunbooksRunbookIdOptions) => { const {baseUrl = "https://demo.octopus.app/api", fetch: fetchFn = fetch, APIKeyHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (APIKeyHeader !== undefined) headers.set("X-Octopus-ApiKey", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/progression/runbooks/${encodeURIComponent(String(args.runbookId))}${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(runbooksProgressionResource, await res.json()) };