Skip to content
Stainless Stainless Stainless
FeedbackDashboard
API Reference
Builds

Creates two comparable builds

builds.compare(BuildCompareParams**kwargs) -> BuildCompareResponse
post/v0/builds/compare

Create two builds whose outputs can be directly compared with each other.

Created builds modify their project branches so that their latest sets of config files point to the ones specified by the input revision.

This endpoint is useful because a build has more inputs than the set of config files it uses, so comparing two builds directly may return spurious differences. Builds made via this endpoint are guaranteed to have differences arising from the set of config files, and any custom code.

ParametersExpand Collapse
base: Base

Parameters for the base build

branch: str

Branch to use. When using a branch name as revision, this must match or be omitted.

revision: Union[str, Dict[str, FileInput]]

Specifies what to build: a branch name, a commit SHA, or file contents.

Accepts one of the following:
BaseRevisionUnionMember0 = str

A branch name, commit SHA, or merge command in the format "base..head"

BaseRevisionUnionMember1 = Dict[str, FileInput]

File contents to commit directly

Accepts one of the following:
class Content: …
content: str

File content

class URL: …
url: str

URL to fetch file content from

commit_message: Optional[str]

Optional commit message to use when creating a new commit.

head: Head

Parameters for the head build

branch: str

Branch to use. When using a branch name as revision, this must match or be omitted.

revision: Union[str, Dict[str, FileInput]]

Specifies what to build: a branch name, a commit SHA, or file contents.

Accepts one of the following:
HeadRevisionUnionMember0 = str

A branch name, commit SHA, or merge command in the format "base..head"

HeadRevisionUnionMember1 = Dict[str, FileInput]

File contents to commit directly

Accepts one of the following:
class Content: …
content: str

File content

class URL: …
url: str

URL to fetch file content from

commit_message: Optional[str]

Optional commit message to use when creating a new commit.

project: Optional[str]

Project name

targets: Optional[List[Target]]

Optional list of SDK targets to build. If not specified, all configured targets will be built.

Accepts one of the following:
"node"
"typescript"
"python"
"go"
"java"
"kotlin"
"ruby"
"terraform"
"cli"
"php"
"csharp"
ReturnsExpand Collapse
class BuildCompareResponse: …
base: 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"]
class DocumentedSpecUnionMember1: …
expires: datetime
type: Literal["url"]
url: str
object: Literal["build"]
org: str
project: str
targets: Targets
cli: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
csharp: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
go: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
java: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
kotlin: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
node: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
php: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
python: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
ruby: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
terraform: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
typescript: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
updated_at: datetime
head: 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"]
class DocumentedSpecUnionMember1: …
expires: datetime
type: Literal["url"]
url: str
object: Literal["build"]
org: str
project: str
targets: Targets
cli: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
csharp: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
go: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
java: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
kotlin: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
node: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
php: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
python: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
ruby: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
terraform: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
typescript: Optional[BuildTarget]
commit: Commit
Accepts one of the following:
class CommitNotStarted: …
status: Literal["not_started"]
class CommitQueued: …
status: Literal["queued"]
class CommitInProgress: …
status: Literal["in_progress"]
class CommitCompleted: …
commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
completed: CommitCompletedCompleted

deprecated

commit: Optional[Commit]
repo: Repo
branch: str
name: str
owner: str
sha: str
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: Optional[CommitCompletedCompletedMergeConflictPr]
number: float
repo: CommitCompletedCompletedMergeConflictPrRepo
name: str
owner: str
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: Optional[CommitCompletedMergeConflictPr]
number: float
repo: CommitCompletedMergeConflictPrRepo
name: str
owner: str
status: Literal["completed"]
install_url: Optional[str]
lint: CheckStep
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
object: Literal["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"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
build: Optional[CheckStep]
Accepts one of the following:
class NotStarted: …
status: Literal["not_started"]
class Queued: …
status: Literal["queued"]
class InProgress: …
status: Literal["in_progress"]
class Completed: …
completed: CompletedCompleted

deprecated

Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
url: Optional[str]
Accepts one of the following:
"success"
"failure"
"skipped"
"cancelled"
"action_required"
"neutral"
"timed_out"
status: Literal["completed"]
url: Optional[str]
updated_at: datetime
Creates two comparable builds
import os
from stainless_v0 import Stainless

client = Stainless(
    api_key=os.environ.get("STAINLESS_API_KEY"),  # This is the default and can be omitted
)
response = client.builds.compare(
    base={
        "branch": "branch",
        "revision": "string",
    },
    head={
        "branch": "branch",
        "revision": "string",
    },
    project="project",
)
print(response.base)
{
  "base": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "head": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
}
Returns Examples
{
  "base": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  },
  "head": {
    "id": "id",
    "config_commit": "config_commit",
    "created_at": "2019-12-27T18:11:19.117Z",
    "documented_spec": {
      "content": "content",
      "type": "content"
    },
    "object": "build",
    "org": "org",
    "project": "project",
    "targets": {
      "cli": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "csharp": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "go": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "java": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "kotlin": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "node": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "php": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "python": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "ruby": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "terraform": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      },
      "typescript": {
        "commit": {
          "status": "not_started"
        },
        "install_url": "install_url",
        "lint": {
          "status": "not_started"
        },
        "object": "build_target",
        "status": "not_started",
        "test": {
          "status": "not_started"
        },
        "build": {
          "status": "not_started"
        }
      }
    },
    "updated_at": "2019-12-27T18:11:19.117Z"
  }
}