import {z} from 'zod' export type GetApiSpaceIdProjectsProjectIdRunbooksArgs = {spaceId: string, projectId: string, excludedRunbookTags?: Array | undefined, partialName?: string | undefined, runbookTags?: Array | undefined, skip?: number | undefined, take?: number | undefined}; export type GetApiSpaceIdProjectsProjectIdRunbooksOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const deploymentConnectivityPolicy = z.object({AllowDeploymentsToNoTargets: z.boolean().optional(), ExcludeUnhealthyTargets: z.boolean().optional(), SkipMachineBehavior: z.enum(["None", "SkipUnavailableMachines"]).optional(), TargetRoles: z.array(z.string()).optional()}); export const runbookRetentionPolicy = z.object({QuantityToKeep: z.number().int().optional(), ShouldKeepForever: z.boolean().optional(), Strategy: z.string().optional(), Unit: z.enum(["Days", "Items"]).optional()}); export const runbookResource = z.object({AgentAccess: z.enum(["Allowed", "Blocked"]).optional(), CancelQueuedTasks: z.boolean().optional(), CancelRunningTasks: z.boolean().optional(), ConnectivityPolicy: deploymentConnectivityPolicy.optional(), DefaultGuidedFailureMode: z.enum(["EnvironmentDefault", "Off", "On"]).optional(), Description: z.string().optional(), Environments: z.array(z.string()).optional(), EnvironmentScope: z.enum(["All", "Specified", "FromProjectLifecycles"]).optional(), FailTargetDiscovery: z.boolean().optional(), ForcePackageDownload: z.boolean().optional(), Id: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), MultiTenancyMode: z.enum(["Untenanted", "TenantedOrUntenanted", "Tenanted"]).optional(), Name: z.string().optional(), ProjectId: z.string().optional(), PublishedRunbookSnapshotId: z.string().optional(), RunbookProcessId: z.string().optional(), RunbookTags: z.array(z.string()).optional(), RunRetentionPolicy: runbookRetentionPolicy.optional(), Slug: z.string().optional(), SpaceId: z.string().optional()}); export const runbookResourceCollection = z.object({Id: z.string().optional(), Items: z.array(runbookResource).optional(), ItemsPerPage: z.number().int().optional(), ItemType: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), LastPageNumber: z.number().int().optional(), Links: z.record(z.string(), z.string()).optional(), NumberOfPages: z.number().int().optional(), TotalResults: z.number().int().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 a paginated list of the Runbooks that belong to the given Project * * GET /{spaceId}/projects/{projectId}/runbooks * * Also accepts auth: APIKeyQuery, NugetApiKeyHeader */ export const getApiSpaceIdProjectsProjectIdRunbooks = async (args: GetApiSpaceIdProjectsProjectIdRunbooksArgs, options?: GetApiSpaceIdProjectsProjectIdRunbooksOptions) => { 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") for (const item of args.excludedRunbookTags ?? []) query.append("excludedRunbookTags", String(item)) if (args.partialName != null) query.append("partialName", String(args.partialName)) for (const item of args.runbookTags ?? []) query.append("runbookTags", String(item)) if (args.skip != null) query.append("skip", String(args.skip)) if (args.take != null) query.append("take", String(args.take)) if (APIKeyHeader !== undefined) headers.set("X-Octopus-ApiKey", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/${encodeURIComponent(String(args.spaceId))}/projects/${encodeURIComponent(String(args.projectId))}/runbooks${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(runbookResourceCollection, await res.json()) };