# Branches ## Create a new project branch `client.Projects.Branches.New(ctx, params) (*ProjectBranch, error)` **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. ### Parameters - `params ProjectBranchNewParams` - `Project param.Field[string]` Path param - `Branch param.Field[string]` Body param: Branch name - `BranchFrom param.Field[string]` Body param: Branch or commit SHA to branch from - `Force param.Field[bool]` Body param: Whether to throw an error if the branch already exists. Defaults to false. ### Returns - `type ProjectBranch struct{…}` 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 string` Branch name - `ConfigCommit ProjectBranchConfigCommit` A Git commit that points to the latest set of config files on a given branch. - `Repo ProjectBranchConfigCommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats ProjectBranchConfigCommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `LatestBuild Build` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` - `Object ProjectBranchObject` - `const ProjectBranchObjectProjectBranch ProjectBranchObject = "project_branch"` - `Org string` - `Project string` Project name ### Example ```go package main import ( "context" "fmt" "github.com/stainless-api/stainless-api-go" "github.com/stainless-api/stainless-api-go/option" ) func main() { client := stainless.NewClient( option.WithAPIKey("My API Key"), ) projectBranch, err := client.Projects.Branches.New(context.TODO(), stainless.ProjectBranchNewParams{ Project: stainless.String("project"), Branch: "branch", BranchFrom: "branch_from", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", projectBranch.Branch) } ``` #### Response ```json { "branch": "branch", "config_commit": { "repo": { "branch": "branch", "host": "host", "name": "name", "owner": "owner" }, "sha": "sha", "stats": { "additions": 0, "deletions": 0, "total": 0 }, "tree_oid": "tree_oid" }, "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", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "csharp": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "go": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "java": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "kotlin": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "node": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "openapi": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "php": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "python": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "ruby": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "sql": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "terraform": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "typescript": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "object": "project_branch", "org": "org", "project": "project" } ``` ## Retrieve a project branch `client.Projects.Branches.Get(ctx, branch, query) (*ProjectBranch, error)` **get** `/v0/projects/{project}/branches/{branch}` Retrieve a project branch by name. ### Parameters - `branch string` - `query ProjectBranchGetParams` - `Project param.Field[string]` ### Returns - `type ProjectBranch struct{…}` 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 string` Branch name - `ConfigCommit ProjectBranchConfigCommit` A Git commit that points to the latest set of config files on a given branch. - `Repo ProjectBranchConfigCommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats ProjectBranchConfigCommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `LatestBuild Build` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` - `Object ProjectBranchObject` - `const ProjectBranchObjectProjectBranch ProjectBranchObject = "project_branch"` - `Org string` - `Project string` Project name ### Example ```go package main import ( "context" "fmt" "github.com/stainless-api/stainless-api-go" "github.com/stainless-api/stainless-api-go/option" ) func main() { client := stainless.NewClient( option.WithAPIKey("My API Key"), ) projectBranch, err := client.Projects.Branches.Get( context.TODO(), "branch", stainless.ProjectBranchGetParams{ Project: stainless.String("project"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", projectBranch.Branch) } ``` #### Response ```json { "branch": "branch", "config_commit": { "repo": { "branch": "branch", "host": "host", "name": "name", "owner": "owner" }, "sha": "sha", "stats": { "additions": 0, "deletions": 0, "total": 0 }, "tree_oid": "tree_oid" }, "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", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "csharp": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "go": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "java": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "kotlin": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "node": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "openapi": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "php": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "python": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "ruby": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "sql": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "terraform": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "typescript": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "object": "project_branch", "org": "org", "project": "project" } ``` ## List project branches `client.Projects.Branches.List(ctx, params) (*Page[ProjectBranchListResponse], error)` **get** `/v0/projects/{project}/branches` Retrieve a project branch by name. ### Parameters - `params ProjectBranchListParams` - `Project param.Field[string]` Path param - `Cursor param.Field[string]` Query param: Pagination cursor from a previous response - `Limit param.Field[float64]` Query param: Maximum number of items to return, defaults to 10 (maximum: 100). ### Returns - `type ProjectBranchListResponse struct{…}` 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 string` Branch name - `ConfigCommit ProjectBranchListResponseConfigCommit` A Git commit that points to the latest set of config files on a given branch. - `Repo ProjectBranchListResponseConfigCommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats ProjectBranchListResponseConfigCommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `LatestBuildID string` - `Object ProjectBranchListResponseObject` - `const ProjectBranchListResponseObjectProjectBranch ProjectBranchListResponseObject = "project_branch"` - `Org string` - `Project string` Project name ### Example ```go package main import ( "context" "fmt" "github.com/stainless-api/stainless-api-go" "github.com/stainless-api/stainless-api-go/option" ) func main() { client := stainless.NewClient( option.WithAPIKey("My API Key"), ) page, err := client.Projects.Branches.List(context.TODO(), stainless.ProjectBranchListParams{ Project: stainless.String("project"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "data": [ { "branch": "branch", "config_commit": { "repo": { "branch": "branch", "host": "host", "name": "name", "owner": "owner" }, "sha": "sha", "stats": { "additions": 0, "deletions": 0, "total": 0 }, "tree_oid": "tree_oid" }, "latest_build_id": "latest_build_id", "object": "project_branch", "org": "org", "project": "project" } ], "has_more": true, "next_cursor": "next_cursor" } ``` ## Delete a project branch `client.Projects.Branches.Delete(ctx, branch, body) (*ProjectBranchDeleteResponse, error)` **delete** `/v0/projects/{project}/branches/{branch}` Delete a project branch by name. ### Parameters - `branch string` - `body ProjectBranchDeleteParams` - `Project param.Field[string]` ### Returns - `type ProjectBranchDeleteResponse interface{…}` ### Example ```go package main import ( "context" "fmt" "github.com/stainless-api/stainless-api-go" "github.com/stainless-api/stainless-api-go/option" ) func main() { client := stainless.NewClient( option.WithAPIKey("My API Key"), ) branch, err := client.Projects.Branches.Delete( context.TODO(), "branch", stainless.ProjectBranchDeleteParams{ Project: stainless.String("project"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", branch) } ``` #### Response ```json {} ``` ## Rebase a project branch `client.Projects.Branches.Rebase(ctx, branch, params) (*ProjectBranch, error)` **put** `/v0/projects/{project}/branches/{branch}/rebase` Rebase a project branch. The branch is rebased onto the `base` branch or commit SHA, inheriting any config and custom code changes. ### Parameters - `branch string` - `params ProjectBranchRebaseParams` - `Project param.Field[string]` Path param - `Base param.Field[string]` Query param: The branch or commit SHA to rebase onto. Defaults to "main". ### Returns - `type ProjectBranch struct{…}` 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 string` Branch name - `ConfigCommit ProjectBranchConfigCommit` A Git commit that points to the latest set of config files on a given branch. - `Repo ProjectBranchConfigCommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats ProjectBranchConfigCommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `LatestBuild Build` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` - `Object ProjectBranchObject` - `const ProjectBranchObjectProjectBranch ProjectBranchObject = "project_branch"` - `Org string` - `Project string` Project name ### Example ```go package main import ( "context" "fmt" "github.com/stainless-api/stainless-api-go" "github.com/stainless-api/stainless-api-go/option" ) func main() { client := stainless.NewClient( option.WithAPIKey("My API Key"), ) projectBranch, err := client.Projects.Branches.Rebase( context.TODO(), "branch", stainless.ProjectBranchRebaseParams{ Project: stainless.String("project"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", projectBranch.Branch) } ``` #### Response ```json { "branch": "branch", "config_commit": { "repo": { "branch": "branch", "host": "host", "name": "name", "owner": "owner" }, "sha": "sha", "stats": { "additions": 0, "deletions": 0, "total": 0 }, "tree_oid": "tree_oid" }, "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", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "csharp": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "go": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "java": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "kotlin": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "node": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "openapi": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "php": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "python": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "ruby": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "sql": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "terraform": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "typescript": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "object": "project_branch", "org": "org", "project": "project" } ``` ## Reset `client.Projects.Branches.Reset(ctx, branch, params) (*ProjectBranch, error)` **put** `/v0/projects/{project}/branches/{branch}/reset` Reset a project branch. If `branch` === `main`, the branch is reset to `target_config_sha`. Otherwise, the branch is reset to `main`. ### Parameters - `branch string` - `params ProjectBranchResetParams` - `Project param.Field[string]` Path param - `TargetConfigSha param.Field[string]` Query param: The commit SHA to reset the main branch to. Required if resetting the main branch; disallowed otherwise. ### Returns - `type ProjectBranch struct{…}` 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 string` Branch name - `ConfigCommit ProjectBranchConfigCommit` A Git commit that points to the latest set of config files on a given branch. - `Repo ProjectBranchConfigCommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats ProjectBranchConfigCommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `LatestBuild Build` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` - `Object ProjectBranchObject` - `const ProjectBranchObjectProjectBranch ProjectBranchObject = "project_branch"` - `Org string` - `Project string` Project name ### Example ```go package main import ( "context" "fmt" "github.com/stainless-api/stainless-api-go" "github.com/stainless-api/stainless-api-go/option" ) func main() { client := stainless.NewClient( option.WithAPIKey("My API Key"), ) projectBranch, err := client.Projects.Branches.Reset( context.TODO(), "branch", stainless.ProjectBranchResetParams{ Project: stainless.String("project"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", projectBranch.Branch) } ``` #### Response ```json { "branch": "branch", "config_commit": { "repo": { "branch": "branch", "host": "host", "name": "name", "owner": "owner" }, "sha": "sha", "stats": { "additions": 0, "deletions": 0, "total": 0 }, "tree_oid": "tree_oid" }, "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", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "csharp": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "go": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "java": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "kotlin": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "node": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "openapi": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "php": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "python": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "ruby": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "sql": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "terraform": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } }, "typescript": { "commit": { "status": "not_started" }, "install_url": "install_url", "object": "build_target", "status": "not_started", "build": { "status": "not_started" }, "lint": { "status": "not_started" }, "test": { "status": "not_started" } } }, "updated_at": "2019-12-27T18:11:19.117Z" }, "object": "project_branch", "org": "org", "project": "project" } ``` ## Domain Types ### Project Branch - `type ProjectBranch struct{…}` 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 string` Branch name - `ConfigCommit ProjectBranchConfigCommit` A Git commit that points to the latest set of config files on a given branch. - `Repo ProjectBranchConfigCommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats ProjectBranchConfigCommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `LatestBuild Build` - `ID string` Build ID - `ConfigCommit string` - `CreatedAt Time` - `DocumentedSpec BuildDocumentedSpecUnion` - `type BuildDocumentedSpecObject struct{…}` - `Content string` - `Type string` - `const BuildDocumentedSpecObjectTypeContent BuildDocumentedSpecObjectType = "content"` - `type BuildDocumentedSpecObject struct{…}` - `Expires Time` - `Type string` - `const BuildDocumentedSpecObjectTypeURL BuildDocumentedSpecObjectType = "url"` - `URL string` - `Object BuildObject` - `const BuildObjectBuild BuildObject = "build"` - `Org string` - `Project string` - `Targets BuildTargets` - `Cli BuildTarget` - `Commit BuildTargetCommitUnion` - `type BuildTargetCommitNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type BuildTargetCommitQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `type BuildTargetCommitInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `type BuildTargetCommitCompleted struct{…}` - `Commit Commit` - `Repo CommitRepo` - `Branch string` - `Host string` - `Name string` - `Owner string` - `Sha string` - `Stats CommitStats` - `Additions int64` - `Deletions int64` - `Total int64` - `TreeOid string` - `Completed BuildTargetCommitCompletedCompleted` deprecated - `Commit Commit` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedCompletedConclusionError BuildTargetCommitCompletedCompletedConclusion = "error"` - `const BuildTargetCommitCompletedCompletedConclusionWarning BuildTargetCommitCompletedCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedCompletedConclusionNote BuildTargetCommitCompletedCompletedConclusion = "note"` - `const BuildTargetCommitCompletedCompletedConclusionSuccess BuildTargetCommitCompletedCompletedConclusion = "success"` - `const BuildTargetCommitCompletedCompletedConclusionMergeConflict BuildTargetCommitCompletedCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedCompletedConclusionFatal BuildTargetCommitCompletedCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedCompletedConclusionPaymentRequired BuildTargetCommitCompletedCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedCompletedConclusionCancelled BuildTargetCommitCompletedCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedCompletedConclusionTimedOut BuildTargetCommitCompletedCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedCompletedConclusionNoop BuildTargetCommitCompletedCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedCompletedConclusionVersionBump BuildTargetCommitCompletedCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `CompletedAt Time` - `Conclusion string` - `const BuildTargetCommitCompletedConclusionError BuildTargetCommitCompletedConclusion = "error"` - `const BuildTargetCommitCompletedConclusionWarning BuildTargetCommitCompletedConclusion = "warning"` - `const BuildTargetCommitCompletedConclusionNote BuildTargetCommitCompletedConclusion = "note"` - `const BuildTargetCommitCompletedConclusionSuccess BuildTargetCommitCompletedConclusion = "success"` - `const BuildTargetCommitCompletedConclusionMergeConflict BuildTargetCommitCompletedConclusion = "merge_conflict"` - `const BuildTargetCommitCompletedConclusionUpstreamMergeConflict BuildTargetCommitCompletedConclusion = "upstream_merge_conflict"` - `const BuildTargetCommitCompletedConclusionFatal BuildTargetCommitCompletedConclusion = "fatal"` - `const BuildTargetCommitCompletedConclusionPaymentRequired BuildTargetCommitCompletedConclusion = "payment_required"` - `const BuildTargetCommitCompletedConclusionCancelled BuildTargetCommitCompletedConclusion = "cancelled"` - `const BuildTargetCommitCompletedConclusionTimedOut BuildTargetCommitCompletedConclusion = "timed_out"` - `const BuildTargetCommitCompletedConclusionNoop BuildTargetCommitCompletedConclusion = "noop"` - `const BuildTargetCommitCompletedConclusionVersionBump BuildTargetCommitCompletedConclusion = "version_bump"` - `MergeConflictPr BuildTargetCommitCompletedMergeConflictPr` - `Number float64` - `Repo BuildTargetCommitCompletedMergeConflictPrRepo` - `Host string` - `Name string` - `Owner string` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `InstallURL string` - `Object BuildTargetObject` - `const BuildTargetObjectBuildTarget BuildTargetObject = "build_target"` - `Status BuildTargetStatus` - `const BuildTargetStatusNotStarted BuildTargetStatus = "not_started"` - `const BuildTargetStatusCodegen BuildTargetStatus = "codegen"` - `const BuildTargetStatusPostgen BuildTargetStatus = "postgen"` - `const BuildTargetStatusCompleted BuildTargetStatus = "completed"` - `Build CheckStepUnion` - `type CheckStepNotStarted struct{…}` - `Status NotStarted` - `const NotStartedNotStarted NotStarted = "not_started"` - `type CheckStepQueued struct{…}` - `Status Queued` - `const QueuedQueued Queued = "queued"` - `URL string` - `type CheckStepInProgress struct{…}` - `Status InProgress` - `const InProgressInProgress InProgress = "in_progress"` - `URL string` - `type CheckStepCompleted struct{…}` - `Completed CheckStepCompletedCompleted` deprecated - `Conclusion string` - `const CheckStepCompletedCompletedConclusionSuccess CheckStepCompletedCompletedConclusion = "success"` - `const CheckStepCompletedCompletedConclusionFailure CheckStepCompletedCompletedConclusion = "failure"` - `const CheckStepCompletedCompletedConclusionSkipped CheckStepCompletedCompletedConclusion = "skipped"` - `const CheckStepCompletedCompletedConclusionCancelled CheckStepCompletedCompletedConclusion = "cancelled"` - `const CheckStepCompletedCompletedConclusionActionRequired CheckStepCompletedCompletedConclusion = "action_required"` - `const CheckStepCompletedCompletedConclusionNeutral CheckStepCompletedCompletedConclusion = "neutral"` - `const CheckStepCompletedCompletedConclusionTimedOut CheckStepCompletedCompletedConclusion = "timed_out"` - `URL string` - `Conclusion string` - `const CheckStepCompletedConclusionSuccess CheckStepCompletedConclusion = "success"` - `const CheckStepCompletedConclusionFailure CheckStepCompletedConclusion = "failure"` - `const CheckStepCompletedConclusionSkipped CheckStepCompletedConclusion = "skipped"` - `const CheckStepCompletedConclusionCancelled CheckStepCompletedConclusion = "cancelled"` - `const CheckStepCompletedConclusionActionRequired CheckStepCompletedConclusion = "action_required"` - `const CheckStepCompletedConclusionNeutral CheckStepCompletedConclusion = "neutral"` - `const CheckStepCompletedConclusionTimedOut CheckStepCompletedConclusion = "timed_out"` - `Status Completed` - `const CompletedCompleted Completed = "completed"` - `URL string` - `Lint CheckStepUnion` - `Test CheckStepUnion` - `Csharp BuildTarget` - `Go BuildTarget` - `Java BuildTarget` - `Kotlin BuildTarget` - `Node BuildTarget` - `OpenAPI BuildTarget` - `Php BuildTarget` - `Python BuildTarget` - `Ruby BuildTarget` - `Sql BuildTarget` - `Terraform BuildTarget` - `Typescript BuildTarget` - `UpdatedAt Time` - `Object ProjectBranchObject` - `const ProjectBranchObjectProjectBranch ProjectBranchObject = "project_branch"` - `Org string` - `Project string` Project name