Skip to content
Stainless Stainless Stainless
FeedbackDashboard
API Reference
Projects

Branches

Create a new project branch
projects.branches.create(BranchCreateParams**kwargs) -> ProjectBranch
post/v0/projects/{project}/branches
Retrieve a project branch
projects.branches.retrieve(strbranch, BranchRetrieveParams**kwargs) -> ProjectBranch
get/v0/projects/{project}/branches/{branch}
List project branches
projects.branches.list(BranchListParams**kwargs) -> SyncPage[BranchListResponse]
get/v0/projects/{project}/branches
Delete a project branch
projects.branches.delete(strbranch, BranchDeleteParams**kwargs) -> object
delete/v0/projects/{project}/branches/{branch}
Rebase a project branch
projects.branches.rebase(strbranch, BranchRebaseParams**kwargs) -> ProjectBranch
put/v0/projects/{project}/branches/{branch}/rebase
Reset
projects.branches.reset(strbranch, BranchResetParams**kwargs) -> ProjectBranch
put/v0/projects/{project}/branches/{branch}/reset
ModelsExpand Collapse
class ProjectBranch: …

A project branch names a line of development for a project. Like a Git branch, it points to a Git commit with a set of config files. In addition, a project branch also points to a set of custom code changes, corresponding to Git branches in the staging repos.

branch: str

Branch name

config_commit: ConfigCommit

A Git commit that points to the latest set of config files on a given branch.

repo: ConfigCommitRepo
branch: str
name: str
owner: str
sha: str
latest_build: Optional[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
object: Literal["project_branch"]
org: str
project: str

Project name