Module types 

Types used as operation parameters and responses.

Modules

error

Error types.

Structs

AcceptInviteRequest

AcceptInviteRequest

ApiToken

A personal API key. The secret is returned only once, at creation.

ApiTokenCreateRequest

Creates a personal API key.

ApiTokenCreateResponse

The created key and its raw secret. The secret is shown only here, once.

ApiTokenListResponse

Every personal API key belonging to the current user.

AuthGithubRequest

GitHub OAuth callback payload from the SPA.

AuthGoogleRequest

Google OAuth callback payload from the SPA.

AuthTokenResponse

A freshly minted session bearer token and the authenticated user.

BalanceResponse

The organization’s current balance — the sum of every ledger entry (credits positive, debits negative). May be negative.

BitbucketOAuthUrlResponse

The Bitbucket authorize URL the SPA should open.

BitbucketRepo

A Bitbucket repository visible to the connected OAuth token.

BitbucketRepoList

Bitbucket repositories visible within the requested workspace.

BitbucketWorkspace

A connected Bitbucket workspace.

BitbucketWorkspaceList

All Bitbucket workspaces the connected OAuth token can access.

Build

One run of a pipeline, identified by its pipeline-scoped number.

BuildList

A page of a pipeline’s builds (newest first), with an opaque cursor.

CheckoutRequest

Starts a Stripe Checkout Session crediting the organization identified by the path (:org). The body carries only the top-up amount in cents.

CheckoutResponse

The hosted Stripe Checkout URL. Redirect the customer here to complete the top-up; on success Stripe fires a webhook that posts the matching credit.

CliClaimRequest

The CLI polls with its nonce to claim the session token the SPA transferred.

CliCodeResponse

A short, human-typeable code the user re-types into the CLI.

CliRedeemRequest

The CLI redeems a paste code the user typed in, receiving the session token.

CliTokenResponse

The raw session bearer token handed to the CLI.

CliTransferRequest

The SPA hands a fresh session token to a locally-running CLI that generated nonce and is polling the claim endpoint.

ConnectBitbucketRequest

OAuth callback payload from the SPA.

ConnectBitbucketResponse

The workspaces connected by the OAuth callback, plus the org slug.

ConnectInstallationRequest

Binds an existing GitHub App installation (identified by its GitHub numeric installation id) to this organization.

CreateBuildRequest

Creates a build for a pipeline. Two paths: supply pre-rendered v0 IR JSON in pipeline_ir (the hm run / API path), or omit pipeline_ir to have the engine render the registered pipeline’s IR in a sandbox VM (decision #5 — rendering never happens on the API host). The IR is then parsed and planned in-process; on a plan/render rejection the build row is created with its error fields set and the request returns 422.

CreateInviteRequest

CreateInviteRequest

CreateOrganizationRequest

Create a new organization owned by the authenticated user.

CreateOrganizationRequestName

Display name. The slug is derived from this.

CreatePipelineRequest

Creates a pipeline within an organization. The slug is derived from the name; a slug collision within the organization is rejected.

CreateRepoBuildRequest

Creates a build by addressing the pipeline through its repo-natural identity — repo_name (owner/repo) plus source_slug (the in-repo @hm.pipeline("…") name) — rather than the org-global slug. This is the hm run path: a repo-local client knows its git remote and its pipeline name but not the namespaced slug. Build semantics are otherwise identical to createBuild.

CurrentUserResponse

The authenticated Harmont user and their personal-org slug.

Error

The Harmont error envelope.

ErrorError

ErrorError

GithubInstallation

A GitHub App installation the organization has connected. The numeric installation_id is GitHub’s installation id (used to address sync/unbind), while id is Harmont’s internal row id.

GithubInstallationList

The organization’s connected GitHub App installations.

GithubRepo

A repository Harmont mirrors from a connected GitHub installation. installation_id is Harmont’s internal installation row id (FK), not GitHub’s installation id.

GithubRepoList

Mirrored repositories for an installation or across an organization.

Invite

Invite

InviteList

InviteList

Job

One job (DAG node) of a build.

JobList

A build’s jobs, in DAG creation order.

LogTokenResponse

A build-scoped HMAC token the SSE log stream accepts, plus its expiry. Pass the token as the token query parameter when opening the log stream.

OrgMember

OrgMember

OrgMemberList

OrgMemberList

Organization

A Harmont organization the authenticated user is a member of.

OrganizationList

A page of the current user’s organizations, with an opaque cursor.

Passkey

A WebAuthn credential registered to the current user.

PasskeyChallengeResponse

The server-side challenge id (correlate it on finalize) and the PublicKeyCredential*Options the browser WebAuthn API consumes.

PasskeyListResponse

Every passkey registered to the current user.

PasskeyLoginFinalizeRequest

Completes passkey login by submitting the assertion for the challenge.

PasskeyLoginOptionsRequest

Starts a discoverable-credential (passkey) login. No fields required.

PasskeyRegisterFinalizeRequest

Completes adding a passkey by submitting the attestation for the challenge.

PasskeyRegisterOptionsResponse

WebAuthn credential-creation options for adding a passkey to the current user, plus the server-side challenge id to echo back on finalize. excludeCredentials lists the user’s already-registered authenticators.

PasskeySignupBeginRequest

Starts passkey sign-up: runs the access gate and emails a verification link.

PasskeySignupFinalizeRequest

Completes passkey sign-up by submitting the attestation for the challenge.

PasskeySignupOptionsRequest

Exchanges a verification token for WebAuthn credential-creation options.

PingResponse

PingResponse

Pipeline

A repeatable CI workflow belonging to an organization.

PipelineList

A page of an organization’s pipelines, with an opaque cursor.

RecoverBeginRequest

Starts magic-link account recovery. Always 204 (never leaks account existence).

RecoverFinalizeRequest

Completes recovery: consumes the magic-link token + challenge, registers a new passkey, and mints a session token.

RecoverOptionsRequest

Validates a magic-link token (without consuming it) and returns WebAuthn credential-creation options to enroll a fresh passkey.

RedeemCouponRequest

Redeems a coupon for the organization identified by the path. The org is taken from the route (:org); the body carries only the coupon code.

RedeemCouponResponse

The credit granted by the coupon and the organization’s resulting balance, both in cents.

RepoRegistration

A single registration channel for a repository. provider is the channel the repo was connected through: github (the GitHub App), bitbucket (Bitbucket OAuth), or cli (reserved for direct CLI registration — not yet emitted). account is the connecting account/workspace login.

RepoSummary

A repository visible to the organization, identified by its canonical clone URL. One logical repository may be registered through several channels (e.g. the GitHub App and the CLI); each appears in registrations.

RepoSummaryList

All repositories visible to the organization, across all providers.

StripeWebhookResponse

Acknowledges that a Stripe webhook event verified and was recorded (idempotently). Returned for any verified event — handled or not — so Stripe stops retrying.

TokenResponse

A freshly minted session bearer token.

Transaction

One append-only ledger entry — a credit (positive) or debit (negative).

TransactionList

A page of an organization’s ledger entries (newest first), with an opaque cursor.

UpdateMemberRoleRequest

UpdateMemberRoleRequest

UsageBreakdownBuild

All VM usage attributed to one build, rolled up and broken down per job.

UsageBreakdownJob

A single job’s VM lease: the VM that ran it, its shape, how long it ran, and what it cost.

UsageBreakdownResponse

An organization’s VM usage over a window, grouped by build (newest first).

UsageResponse

Aggregated VM-lease usage for an organization over the requested [from, to) window: resource-seconds per dimension and the total billed cost in cents.

UsageSeriesBucket

UsageSeriesBucket

UsageSeriesResponse

UsageSeriesResponse

User

The authenticated Harmont user.

UserUpdateRequest

Updates the current user’s editable profile fields.

UserUpdateRequestName

New display name.

Enums

BuildState

The rolled-up build state.

CreateInviteRequestRole

CreateInviteRequestRole

InviteRole

InviteRole

JobState

The job’s FSM state.

OrgMemberRole

OrgMemberRole

PipelineVisibility

Whether the pipeline is private or public.

StripeWebhookResponseStatus

Always "ok" on a verified, recorded event.

TransactionSource

What produced the entry.

UpdateMemberRoleRequestRole

UpdateMemberRoleRequestRole