refactor(api): change completed shape

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 20
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/stainless%2Fstainless-v0-36086d31791dca6112f0c79f44f296d0cdea35df74f4b3b725f86296a51a86fd.yml
-openapi_spec_hash: 0ac69304e57ec27533774ed339a44314
-config_hash: 8563083ae1fa5c137476fb1237aa8ea9
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/stainless%2Fstainless-v0-babb926f3cc81e4b1d5f10f5cb0f36fc2fd5da122c32a9c2d373d83cb8977848.yml
+openapi_spec_hash: e8cb8b819592f7703532f3a7ef1585ef
+config_hash: f1b8a43873719fc8f2789008f3aa2260

aliases.go

@@ -22,6 +22,45 @@ type Commit = shared.Commit
 // This is an alias to an internal type.
 type CommitRepo = shared.CommitRepo
 
+// This is an alias to an internal type.
+type CommitConclusion = shared.CommitConclusion
+
+// Equals "error"
+const CommitConclusionError = shared.CommitConclusionError
+
+// Equals "warning"
+const CommitConclusionWarning = shared.CommitConclusionWarning
+
+// Equals "note"
+const CommitConclusionNote = shared.CommitConclusionNote
+
+// Equals "success"
+const CommitConclusionSuccess = shared.CommitConclusionSuccess
+
+// Equals "merge_conflict"
+const CommitConclusionMergeConflict = shared.CommitConclusionMergeConflict
+
+// Equals "upstream_merge_conflict"
+const CommitConclusionUpstreamMergeConflict = shared.CommitConclusionUpstreamMergeConflict
+
+// Equals "fatal"
+const CommitConclusionFatal = shared.CommitConclusionFatal
+
+// Equals "payment_required"
+const CommitConclusionPaymentRequired = shared.CommitConclusionPaymentRequired
+
+// Equals "cancelled"
+const CommitConclusionCancelled = shared.CommitConclusionCancelled
+
+// Equals "timed_out"
+const CommitConclusionTimedOut = shared.CommitConclusionTimedOut
+
+// Equals "noop"
+const CommitConclusionNoop = shared.CommitConclusionNoop
+
+// Equals "version_bump"
+const CommitConclusionVersionBump = shared.CommitConclusionVersionBump
+
 // This is an alias to an internal type.
 type FileInputUnionParam = shared.FileInputUnionParam
 

api.md

@@ -6,6 +6,7 @@
 # Shared Response Types
 
 - <a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go/shared#Commit">Commit</a>
+- <a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go/shared#CommitConclusion">CommitConclusion</a>
 - <a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go/shared">shared</a>.<a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go/shared#Target">Target</a>
 
 # Projects
@@ -57,6 +58,7 @@ Response Types:
 - <a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go">stainless</a>.<a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go#Build">Build</a>
 - <a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go">stainless</a>.<a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go#BuildTarget">BuildTarget</a>
 - <a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go">stainless</a>.<a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go#CheckStepUnion">CheckStepUnion</a>
+- <a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go">stainless</a>.<a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go#CheckStepConclusion">CheckStepConclusion</a>
 - <a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go">stainless</a>.<a href="https://pkg.go.dev/github.com/stainless-api/stainless-api-go#BuildCompareResponse">BuildCompareResponse</a>
 
 Methods:

build.go

@@ -304,11 +304,20 @@ type BuildTargetCommitUnion struct {
 	// Any of "not_started", "queued", "in_progress", "completed".
 	Status string `json:"status"`
 	// This field is from variant [BuildTargetCommitCompleted].
+	Commit shared.Commit `json:"commit"`
+	// This field is from variant [BuildTargetCommitCompleted].
 	Completed BuildTargetCommitCompletedCompleted `json:"completed"`
-	JSON      struct {
-		Status    respjson.Field
-		Completed respjson.Field
-		raw       string
+	// This field is from variant [BuildTargetCommitCompleted].
+	Conclusion shared.CommitConclusion `json:"conclusion"`
+	// This field is from variant [BuildTargetCommitCompleted].
+	MergeConflictPr BuildTargetCommitCompletedMergeConflictPr `json:"merge_conflict_pr"`
+	JSON            struct {
+		Status          respjson.Field
+		Commit          respjson.Field
+		Completed       respjson.Field
+		Conclusion      respjson.Field
+		MergeConflictPr respjson.Field
+		raw             string
 	} `json:"-"`
 }
 
@@ -423,14 +432,24 @@ func (r *BuildTargetCommitInProgress) UnmarshalJSON(data []byte) error {
 }
 
 type BuildTargetCommitCompleted struct {
+	Commit shared.Commit `json:"commit,required"`
+	// deprecated
 	Completed BuildTargetCommitCompletedCompleted `json:"completed,required"`
-	Status    constant.Completed                  `json:"status,required"`
+	// Any of "error", "warning", "note", "success", "merge_conflict",
+	// "upstream_merge_conflict", "fatal", "payment_required", "cancelled",
+	// "timed_out", "noop", "version_bump".
+	Conclusion      shared.CommitConclusion                   `json:"conclusion,required"`
+	MergeConflictPr BuildTargetCommitCompletedMergeConflictPr `json:"merge_conflict_pr,required"`
+	Status          constant.Completed                        `json:"status,required"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
 	JSON struct {
-		Completed   respjson.Field
-		Status      respjson.Field
-		ExtraFields map[string]respjson.Field
-		raw         string
+		Commit          respjson.Field
+		Completed       respjson.Field
+		Conclusion      respjson.Field
+		MergeConflictPr respjson.Field
+		Status          respjson.Field
+		ExtraFields     map[string]respjson.Field
+		raw             string
 	} `json:"-"`
 }
 
@@ -440,12 +459,13 @@ func (r *BuildTargetCommitCompleted) UnmarshalJSON(data []byte) error {
 	return apijson.UnmarshalRoot(data, r)
 }
 
+// deprecated
 type BuildTargetCommitCompletedCompleted struct {
 	Commit shared.Commit `json:"commit,required"`
 	// Any of "error", "warning", "note", "success", "merge_conflict",
 	// "upstream_merge_conflict", "fatal", "payment_required", "cancelled",
 	// "timed_out", "noop", "version_bump".
-	Conclusion      string                                             `json:"conclusion,required"`
+	Conclusion      shared.CommitConclusion                            `json:"conclusion,required"`
 	MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr `json:"merge_conflict_pr,required"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
 	JSON struct {
@@ -499,6 +519,42 @@ func (r *BuildTargetCommitCompletedCompletedMergeConflictPrRepo) UnmarshalJSON(d
 	return apijson.UnmarshalRoot(data, r)
 }
 
+type BuildTargetCommitCompletedMergeConflictPr struct {
+	Number float64                                       `json:"number,required"`
+	Repo   BuildTargetCommitCompletedMergeConflictPrRepo `json:"repo,required"`
+	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
+	JSON struct {
+		Number      respjson.Field
+		Repo        respjson.Field
+		ExtraFields map[string]respjson.Field
+		raw         string
+	} `json:"-"`
+}
+
+// Returns the unmodified JSON received from the API
+func (r BuildTargetCommitCompletedMergeConflictPr) RawJSON() string { return r.JSON.raw }
+func (r *BuildTargetCommitCompletedMergeConflictPr) UnmarshalJSON(data []byte) error {
+	return apijson.UnmarshalRoot(data, r)
+}
+
+type BuildTargetCommitCompletedMergeConflictPrRepo struct {
+	Name  string `json:"name,required"`
+	Owner string `json:"owner,required"`
+	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
+	JSON struct {
+		Name        respjson.Field
+		Owner       respjson.Field
+		ExtraFields map[string]respjson.Field
+		raw         string
+	} `json:"-"`
+}
+
+// Returns the unmodified JSON received from the API
+func (r BuildTargetCommitCompletedMergeConflictPrRepo) RawJSON() string { return r.JSON.raw }
+func (r *BuildTargetCommitCompletedMergeConflictPrRepo) UnmarshalJSON(data []byte) error {
+	return apijson.UnmarshalRoot(data, r)
+}
+
 type BuildTargetObject string
 
 const (
@@ -526,10 +582,16 @@ type CheckStepUnion struct {
 	Status string `json:"status"`
 	// This field is from variant [CheckStepCompleted].
 	Completed CheckStepCompletedCompleted `json:"completed"`
-	JSON      struct {
-		Status    respjson.Field
-		Completed respjson.Field
-		raw       string
+	// This field is from variant [CheckStepCompleted].
+	Conclusion CheckStepConclusion `json:"conclusion"`
+	// This field is from variant [CheckStepCompleted].
+	URL  string `json:"url"`
+	JSON struct {
+		Status     respjson.Field
+		Completed  respjson.Field
+		Conclusion respjson.Field
+		URL        respjson.Field
+		raw        string
 	} `json:"-"`
 }
 
@@ -644,12 +706,19 @@ func (r *CheckStepInProgress) UnmarshalJSON(data []byte) error {
 }
 
 type CheckStepCompleted struct {
+	// deprecated
 	Completed CheckStepCompletedCompleted `json:"completed,required"`
-	Status    constant.Completed          `json:"status,required"`
+	// Any of "success", "failure", "skipped", "cancelled", "action_required",
+	// "neutral", "timed_out".
+	Conclusion CheckStepConclusion `json:"conclusion,required"`
+	Status     constant.Completed  `json:"status,required"`
+	URL        string              `json:"url,required"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
 	JSON struct {
 		Completed   respjson.Field
+		Conclusion  respjson.Field
 		Status      respjson.Field
+		URL         respjson.Field
 		ExtraFields map[string]respjson.Field
 		raw         string
 	} `json:"-"`
@@ -661,11 +730,12 @@ func (r *CheckStepCompleted) UnmarshalJSON(data []byte) error {
 	return apijson.UnmarshalRoot(data, r)
 }
 
+// deprecated
 type CheckStepCompletedCompleted struct {
 	// Any of "success", "failure", "skipped", "cancelled", "action_required",
 	// "neutral", "timed_out".
-	Conclusion string `json:"conclusion,required"`
-	URL        string `json:"url,required"`
+	Conclusion CheckStepConclusion `json:"conclusion,required"`
+	URL        string              `json:"url,required"`
 	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
 	JSON struct {
 		Conclusion  respjson.Field
@@ -681,6 +751,18 @@ func (r *CheckStepCompletedCompleted) UnmarshalJSON(data []byte) error {
 	return apijson.UnmarshalRoot(data, r)
 }
 
+type CheckStepConclusion string
+
+const (
+	CheckStepConclusionSuccess        CheckStepConclusion = "success"
+	CheckStepConclusionFailure        CheckStepConclusion = "failure"
+	CheckStepConclusionSkipped        CheckStepConclusion = "skipped"
+	CheckStepConclusionCancelled      CheckStepConclusion = "cancelled"
+	CheckStepConclusionActionRequired CheckStepConclusion = "action_required"
+	CheckStepConclusionNeutral        CheckStepConclusion = "neutral"
+	CheckStepConclusionTimedOut       CheckStepConclusion = "timed_out"
+)
+
 type BuildCompareResponse struct {
 	Base Build `json:"base,required"`
 	Head Build `json:"head,required"`

shared/shared.go

@@ -52,6 +52,23 @@ func (r *CommitRepo) UnmarshalJSON(data []byte) error {
 	return apijson.UnmarshalRoot(data, r)
 }
 
+type CommitConclusion string
+
+const (
+	CommitConclusionError                 CommitConclusion = "error"
+	CommitConclusionWarning               CommitConclusion = "warning"
+	CommitConclusionNote                  CommitConclusion = "note"
+	CommitConclusionSuccess               CommitConclusion = "success"
+	CommitConclusionMergeConflict         CommitConclusion = "merge_conflict"
+	CommitConclusionUpstreamMergeConflict CommitConclusion = "upstream_merge_conflict"
+	CommitConclusionFatal                 CommitConclusion = "fatal"
+	CommitConclusionPaymentRequired       CommitConclusion = "payment_required"
+	CommitConclusionCancelled             CommitConclusion = "cancelled"
+	CommitConclusionTimedOut              CommitConclusion = "timed_out"
+	CommitConclusionNoop                  CommitConclusion = "noop"
+	CommitConclusionVersionBump           CommitConclusion = "version_bump"
+)
+
 func FileInputParamOfFileInputContent(content string) FileInputUnionParam {
 	var variant FileInputContentParam
 	variant.Content = content