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

Create a new branch for a project.

The branch inherits the config files from the revision pointed to by the branch_from parameter. In addition, if the revision is a branch name, the branch will also inherit custom code changes from that branch.

ParametersExpand Collapse
project: Optional[str]
branch: str

Branch name

branch_from: str

Branch or commit SHA to branch from

force: Optional[bool]

Whether to throw an error if the branch already exists. Defaults to false.

ReturnsExpand 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

Create a new project branch
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
)
project_branch = client.projects.branches.create(
    project="project",
    branch="branch",
    branch_from="branch_from",
)
print(project_branch.branch)
{
  "branch": "branch",
  "config_commit": {
    "repo": {
      "branch": "branch",
      "name": "name",
      "owner": "owner"
    },
    "sha": "sha"
  },
  "latest_build": {
    "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"
  },
  "object": "project_branch",
  "org": "org",
  "project": "project"
}
Returns Examples
{
  "branch": "branch",
  "config_commit": {
    "repo": {
      "branch": "branch",
      "name": "name",
      "owner": "owner"
    },
    "sha": "sha"
  },
  "latest_build": {
    "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"
  },
  "object": "project_branch",
  "org": "org",
  "project": "project"
}