Skip to content
Stainless Stainless Stainless SDKs
Get started
API Reference

Builds

List project builds
builds.list(BuildListParams**kwargs) -> SyncPage[Build]
get/v0/builds
Create build
builds.create(BuildCreateParams**kwargs) -> Build
post/v0/builds
Retrieve build
builds.retrieve(strbuild_id) -> Build
get/v0/builds/{buildId}
Creates two comparable builds
builds.compare(BuildCompareParams**kwargs) -> BuildCompareResponse
post/v0/builds/compare
ModelsExpand Collapse
class Build: …
id: str

Build ID

config_commit: str
created_at: datetime
documented_spec: Optional[DocumentedSpec]
Accepts one of the following:
class DocumentedSpecUnionMember0: …
content: str
type: Literal["content"]
Accepts one of the following:
"content"
class DocumentedSpecUnionMember1: …
expires: datetime
type: Literal["url"]
Accepts one of the following:
"url"
url: str
object: Literal["build"]
Accepts one of the following:
"build"
org: str
project: str
targets: Targets
cli: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
csharp: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
go: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
java: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
kotlin: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
node: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
php: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
python: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
ruby: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
terraform: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
typescript: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
updated_at: datetime
class BuildTarget: …
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class CommitQueued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class CommitInProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class CommitCompleted: …
completed: CommitCompletedCompleted
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
conclusion: Literal["error", "warning", "note", 9 more]
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
Accepts one of the following:
"completed"
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
object: Literal["build_target"]
Accepts one of the following:
"build_target"
status: Literal["not_started", "codegen", "postgen", "completed"]
Accepts one of the following:
"not_started"
"codegen"
"postgen"
"completed"
test: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"
CheckStep = CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
Accepts one of the following:
"not_started"
class Queued: …
status: Literal["queued"]
Accepts one of the following:
"queued"
class InProgress: …
status: Literal["in_progress"]
Accepts one of the following:
"in_progress"
class Completed: …
completed: CompletedCompleted
conclusion: Literal["success", "failure", "skipped", 4 more]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
status: Literal["completed"]
Accepts one of the following:
"completed"

BuildsDiagnostics

Get diagnostics for a build
builds.diagnostics.list(strbuild_id, DiagnosticListParams**kwargs) -> SyncPage[BuildDiagnostic]
get/v0/builds/{buildId}/diagnostics
ModelsExpand Collapse
class BuildDiagnostic: …
code: str

The kind of diagnostic.

ignored: bool

Whether the diagnostic is ignored in the Stainless config.

level: Literal["fatal", "error", "warning", "note"]

The severity of the diagnostic.

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

A description of the diagnostic.

more: Optional[BuildDiagnosticMore]
Accepts one of the following:
class Markdown: …
markdown: str
type: Literal["markdown"]
Accepts one of the following:
"markdown"
class Raw: …
raw: str
type: Literal["raw"]
Accepts one of the following:
"raw"
config_ref: Optional[str]

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

oas_ref: Optional[str]

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

BuildDiagnosticMore = BuildDiagnosticMore
Accepts one of the following:
class Markdown: …
markdown: str
type: Literal["markdown"]
Accepts one of the following:
"markdown"
class Raw: …
raw: str
type: Literal["raw"]
Accepts one of the following:
"raw"

BuildsTarget Outputs

Download build target output
builds.target_outputs.retrieve(TargetOutputRetrieveParams**kwargs) -> TargetOutputRetrieveResponse
get/v0/build_target_outputs