Skip to content
Stainless Stainless Stainless
FeedbackDashboard
API Reference

Builds

List project builds
client.builds.list(BuildListParams { project, branch, cursor, 2 more } params?, RequestOptionsoptions?): Page<Build { id, config_commit, created_at, 6 more } >
get/v0/builds
Create build
client.builds.create(BuildCreateParams { project, revision, allow_empty, 4 more } params, RequestOptionsoptions?): Build { id, config_commit, created_at, 6 more }
post/v0/builds
Retrieve build
client.builds.retrieve(stringbuildID, RequestOptionsoptions?): Build { id, config_commit, created_at, 6 more }
get/v0/builds/{buildId}
Creates two comparable builds
client.builds.compare(BuildCompareParams { base, head, project, targets } params, RequestOptionsoptions?): BuildCompareResponse { base, head }
post/v0/builds/compare
ModelsExpand Collapse
Build { id, config_commit, created_at, 6 more }
id: string

Build ID

config_commit: string
created_at: string
documented_spec: UnionMember0 { content, type } | UnionMember1 { expires, type, url } | null
Accepts one of the following:
UnionMember0 { content, type }
content: string
type: "content"
UnionMember1 { expires, type, url }
expires: string
type: "url"
url: string
object: "build"
org: string
project: string
targets: Targets { cli, csharp, go, 9 more }
cli?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
csharp?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
go?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
java?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
kotlin?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
node?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
openapi?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
php?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
python?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
ruby?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
terraform?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
typescript?: BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
updated_at: string
BuildTarget { commit, install_url, lint, 4 more }
commit: NotStarted { status } | Queued { status } | InProgress { status } | Completed { commit, completed, conclusion, 2 more }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { commit, completed, conclusion, 2 more }
commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
completed: Completed { commit, conclusion, merge_conflict_pr }

deprecated

commit: Commit { repo, sha } | null
repo: Repo { branch, name, owner }
branch: string
name: string
owner: string
sha: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
conclusion: CommitConclusion
Accepts one of the following:
"error"
"warning"
"note"
"success"
"merge_conflict"
"upstream_merge_conflict"
"fatal"
"payment_required"
"cancelled"
"timed_out"
"noop"
"version_bump"
merge_conflict_pr: MergeConflictPr | null
number: number
repo: Repo { name, owner }
name: string
owner: string
status: "completed"
install_url: string | null
lint: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
object: "build_target"
status: "not_started" | "codegen" | "postgen" | "completed"
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
build?: CheckStep
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
CheckStep = NotStarted { status } | Queued { status } | InProgress { status } | Completed { completed, conclusion, status, url }
Accepts one of the following:
NotStarted { status }
status: "not_started"
Queued { status }
status: "queued"
InProgress { status }
status: "in_progress"
Completed { completed, conclusion, status, url }
completed: Completed { conclusion, url }

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: string | null
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: "completed"
url: string | null
CheckStepConclusion = "success" | "failure" | "skipped" | 4 more
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"

BuildsDiagnostics

Get diagnostics for a build
client.builds.diagnostics.list(stringbuildID, DiagnosticListParams { cursor, limit, severity, targets } query?, RequestOptionsoptions?): Page<BuildDiagnostic { code, ignored, level, 4 more } >
get/v0/builds/{buildId}/diagnostics
ModelsExpand Collapse
BuildDiagnostic { code, ignored, level, 4 more }
code: string

The kind of diagnostic.

ignored: boolean

Whether the diagnostic is ignored in the Stainless config.

level: "fatal" | "error" | "warning" | "note"

The severity of the diagnostic.

Accepts one of the following:
"fatal"
"error"
"warning"
"note"
message: string

A description of the diagnostic.

more: BuildDiagnosticMore | null
Accepts one of the following:
Markdown { markdown, type }
markdown: string
type: "markdown"
Raw { raw, type }
raw: string
type: "raw"
config_ref?: string

A JSON pointer to a relevant field in the Stainless config.

oas_ref?: string

A JSON pointer to a relevant field in the OpenAPI spec.

BuildDiagnosticMore = Markdown { markdown, type } | Raw { raw, type }
Accepts one of the following:
Markdown { markdown, type }
markdown: string
type: "markdown"
Raw { raw, type }
raw: string
type: "raw"

BuildsTarget Outputs

Download build target output
client.builds.targetOutputs.retrieve(TargetOutputRetrieveParams { build_id, target, type, output } query, RequestOptionsoptions?): TargetOutputRetrieveResponse
get/v0/build_target_outputs