import {z} from 'zod' export type GetApiProjectsProjectIdGitrefRunbooksRunbookIdRunbookSnapshotTemplateArgs = {projectId: string, gitref: string, runbookId: string}; export type GetApiProjectsProjectIdGitrefRunbooksRunbookIdRunbookSnapshotTemplateOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const gitReferenceResource = z.object({GitCommit: z.string().optional(), GitRef: z.string().optional()}); export const releaseTemplateGitResource = z.object({ActionName: z.string().min(1), DefaultBranch: z.string().min(1), FilePathFilters: z.array(z.string()).optional(), GitCredentialId: z.string().optional(), GitHubConnectionId: z.string().optional(), GitResourceSelectedLastRelease: gitReferenceResource.optional(), IsResolvable: z.boolean(), Name: z.string(), RepositoryUri: z.string().min(1)}); export const releaseTemplatePackage = z.object({ActionName: z.string().optional(), FeedId: z.string().optional(), FeedName: z.string().optional(), FixedVersion: z.string().optional(), IsResolvable: z.boolean().optional(), NuGetFeedId: z.string().optional(), NuGetFeedName: z.string().optional(), NuGetPackageId: z.string().optional(), PackageId: z.string().optional(), PackageReferenceName: z.string().optional(), ProjectName: z.string().optional(), StepName: z.string().optional(), VersionSelectedLastRelease: z.string().optional()}); export const runbookSnapshotTemplateResource = z.object({GitResources: z.array(releaseTemplateGitResource).optional(), Id: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), NextNameIncrement: z.string().optional(), Packages: z.array(releaseTemplatePackage).optional(), RunbookId: z.string().optional(), RunbookProcessId: z.string().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 of the information necessary for creating or editing a Snapshot for a Runbook * * GET /projects/{projectId}/{gitref}/runbooks/{runbookId}/runbookSnapshotTemplate * * Also accepts auth: APIKeyQuery, NugetApiKeyHeader */ export const getApiProjectsProjectIdGitrefRunbooksRunbookIdRunbookSnapshotTemplate = async (args: GetApiProjectsProjectIdGitrefRunbooksRunbookIdRunbookSnapshotTemplateArgs, options?: GetApiProjectsProjectIdGitrefRunbooksRunbookIdRunbookSnapshotTemplateOptions) => { 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(/\/+$/, '')}/projects/${encodeURIComponent(String(args.projectId))}/${encodeURIComponent(String(args.gitref))}/runbooks/${encodeURIComponent(String(args.runbookId))}/runbookSnapshotTemplate${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(runbookSnapshotTemplateResource, await res.json()) };