Merge pull request #14 from stainless-api/release-please--branches--main--changes--next

release: 0.2.0

Author: yjp20

.github/workflows/ci.yml

@@ -1,17 +1,19 @@
 name: CI
 on:
   push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-      - next
+    branches-ignore:
+      - 'generated'
+      - 'codegen/**'
+      - 'integrated/**'
+      - 'stl-preview-head/**'
+      - 'stl-preview-base/**'
 
 jobs:
   lint:
+    timeout-minutes: 10
     name: lint
-    runs-on: ubuntu-latest
+    runs-on: ${{ github.repository == 'stainless-sdks/stainless-v0-go' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
+
     steps:
       - uses: actions/checkout@v4
 
@@ -23,8 +25,9 @@ jobs:
       - name: Run lints
         run: ./scripts/lint
   test:
+    timeout-minutes: 10
     name: test
-    runs-on: ubuntu-latest
+    runs-on: ${{ github.repository == 'stainless-sdks/stainless-v0-go' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }}
     steps:
       - uses: actions/checkout@v4
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.1"
+  ".": "0.2.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 11
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/stainless%2Fstainless-v0-6cc6dbcccc2b281f55ced484ddf562c7615d5facb27db5599575e253d9a9a47c.yml
-openapi_spec_hash: d74c662cb71cffec14b86f666f53f7c4
-config_hash: bf9f13a248e3d2f6cb014c313f9870a3
+configured_endpoints: 10
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/stainless%2Fstainless-v0-c9f598f79a7265337b04e831c4c36bfd8216901c74a5e6d14a38e30d33ec731b.yml
+openapi_spec_hash: 458ba78d4ac13aea449822777e9194a5
+config_hash: 8817e4ad583190fe8c46f5044c5dca03

CHANGELOG.md

@@ -1,5 +1,42 @@
 # Changelog
 
+## 0.2.0 (2025-04-24)
+
+Full Changelog: [v0.1.1...v0.2.0](https://github.com/stainless-api/stainless-api-go/compare/v0.1.1...v0.2.0)
+
+### Features
+
+* add typescript ([1631f7a](https://github.com/stainless-api/stainless-api-go/commit/1631f7ad568491a66ed0b7e5821879cd5645cb21))
+* **api:** configs ([675c5b1](https://github.com/stainless-api/stainless-api-go/commit/675c5b10c1cffd923f32261fa1cb06e1134b1775))
+* **api:** fix enum name conflict maybe ([f21813c](https://github.com/stainless-api/stainless-api-go/commit/f21813cad5d2237595d1389bbe25747649055da7))
+* **api:** manual updates ([f9b7e82](https://github.com/stainless-api/stainless-api-go/commit/f9b7e82bda7ad171be29985d013ce47781a8b6b0))
+* **api:** manual updates ([4b28524](https://github.com/stainless-api/stainless-api-go/commit/4b285245767a00f24bda90c3088279d7d3b1a1e7))
+* **api:** manual updates ([59ac5d0](https://github.com/stainless-api/stainless-api-go/commit/59ac5d095d4677f1722b76a9fc1c7531a424512a))
+* **api:** manual updates ([88c1005](https://github.com/stainless-api/stainless-api-go/commit/88c10052262103a1b01809a0b9d43892f72c8657))
+* **api:** manual updates ([c6af2bc](https://github.com/stainless-api/stainless-api-go/commit/c6af2bc172620f147bdb7b78b02b015c9c647150))
+* **api:** manual updates ([ee18ef8](https://github.com/stainless-api/stainless-api-go/commit/ee18ef80f20bfe06e6c2c4eb665d82f3bfd9143f))
+* **api:** manual updates ([b52a583](https://github.com/stainless-api/stainless-api-go/commit/b52a58329e8013cb34e4add568bc6b2f877c2628))
+* **api:** manual updates ([03ae282](https://github.com/stainless-api/stainless-api-go/commit/03ae28279f75772025d2641212969db6409b11a5))
+* **api:** parent build id ([ef14ee0](https://github.com/stainless-api/stainless-api-go/commit/ef14ee06c9ca5b16e10d2bdc6dce19d327cc1355))
+* **api:** remove discriminator thing ([40f8bc0](https://github.com/stainless-api/stainless-api-go/commit/40f8bc0dd275031d0f7bc9a90e5a610676edda6e))
+* **api:** use correct hashes ([e118e5a](https://github.com/stainless-api/stainless-api-go/commit/e118e5a173e468eb037b0e12e25d7e4e62cba6e9))
+* change list endpoint ([8a34e45](https://github.com/stainless-api/stainless-api-go/commit/8a34e451abf01b2748a339990944f93b33787ddf))
+* **client:** support more time formats ([dde7235](https://github.com/stainless-api/stainless-api-go/commit/dde72351a8cfbf8271984e9fda80b630d3fdf161))
+
+
+### Bug Fixes
+
+* **client:** time format encoding fix ([67abcf1](https://github.com/stainless-api/stainless-api-go/commit/67abcf1ace98c409d908e09f3d033cbfcf4a32e0))
+
+
+### Chores
+
+* **ci:** add timeout thresholds for CI jobs ([d6b6255](https://github.com/stainless-api/stainless-api-go/commit/d6b625593d4244a7a5ef5f98dbec567e5befb0de))
+* **ci:** only use depot for staging repos ([2275406](https://github.com/stainless-api/stainless-api-go/commit/22754063ee707b8b0527f7b72b736180c48ecbc7))
+* **internal:** codegen related update ([d0aa369](https://github.com/stainless-api/stainless-api-go/commit/d0aa3690b2c934f19a9d3d0f60d0f1167fb1eb9c))
+* **readme:** improve formatting ([cc1106d](https://github.com/stainless-api/stainless-api-go/commit/cc1106df35a95fb7719589acc66c42c6bf2ff8cc))
+* **utils:** add internal resp to param utility ([d69809f](https://github.com/stainless-api/stainless-api-go/commit/d69809f2f39bd1717bae31887079edac00ccabcc))
+
 ## 0.1.1 (2025-04-18)
 
 Full Changelog: [v0.1.0-alpha.2...v0.1.1](https://github.com/stainless-api/stainless-api-go/compare/v0.1.0-alpha.2...v0.1.1)

README.md

@@ -24,7 +24,7 @@ Or to pin the version:
 <!-- x-release-please-start-version -->
 
 ```sh
-go get -u 'github.com/stainless-api/stainless-api-go@v0.1.1'
+go get -u 'github.com/stainless-api/stainless-api-go@v0.2.0'
 ```
 
 <!-- x-release-please-end -->
@@ -52,11 +52,16 @@ func main() {
 	client := stainlessv0.NewClient(
 		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("STAINLESS_V0_API_KEY")
 	)
-	openAPI, err := client.OpenAPI.Get(context.TODO())
+	buildObject, err := client.Builds.New(context.TODO(), stainlessv0.BuildNewParams{
+		Project: "project",
+		Revision: stainlessv0.BuildNewParamsRevisionUnion{
+			OfString: stainlessv0.String("string"),
+		},
+	})
 	if err != nil {
 		panic(err.Error())
 	}
-	fmt.Printf("%+v\n", openAPI)
+	fmt.Printf("%+v\n", buildObject.ID)
 }
 
 ```
@@ -66,29 +71,18 @@ func main() {
 The stainlessv0 library uses the [`omitzero`](https://tip.golang.org/doc/go1.24#encodingjsonpkgencodingjson)
 semantics from the Go 1.24+ `encoding/json` release for request fields.
 
-Required primitive fields (`int64`, `string`, etc.) feature the tag <code>\`json:...,required\`</code>. These
+Required primitive fields (`int64`, `string`, etc.) feature the tag <code>\`json:"...,required"\`</code>. These
 fields are always serialized, even their zero values.
 
-Optional primitive types are wrapped in a `param.Opt[T]`. Use the provided constructors set `param.Opt[T]` fields such as `stainlessv0.String(string)`, `stainlessv0.Int(int64)`, etc.
-
-Optional primitives, maps, slices and structs and string enums (represented as `string`) always feature the
-tag <code>\`json:"...,omitzero"\`</code>. Their zero values are considered omitted.
-
-Any non-nil slice of length zero will serialize as an empty JSON array, `"[]"`. Similarly, any non-nil map with length zero with serialize as an empty JSON object, `"{}"`.
-
-To send `null` instead of an `param.Opt[T]`, use `param.NullOpt[T]()`.
-To send `null` instead of a struct, use `param.NullObj[T]()`, where `T` is a struct.
-To send a custom value instead of a struct, use `param.OverrideObj[T](value)`.
+Optional primitive types are wrapped in a `param.Opt[T]`. These fields can be set with the provided constructors, `stainlessv0.String(string)`, `stainlessv0.Int(int64)`, etc.
 
-To override request structs contain a `.WithExtraFields(map[string]any)` method which can be used to
-send non-conforming fields in the request body. Extra fields overwrite any struct fields with a matching
-key, so only use with trusted data.
+Any `param.Opt[T]`, map, slice, struct or string enum uses the
+tag <code>\`json:"...,omitzero"\`</code>. Its zero value is considered omitted.
 
 ```go
 params := stainlessv0.ExampleParams{
-	ID:          "id_xxx",                  // required property
-	Name:        stainlessv0.String("..."), // optional property
-	Description: param.NullOpt[string](),   // explicit null property
+	ID:   "id_xxx",                  // required property
+	Name: stainlessv0.String("..."), // optional property
 
 	Point: stainlessv0.Point{
 		X: 0,                  // required field will serialize as 0
@@ -98,7 +92,23 @@ params := stainlessv0.ExampleParams{
 
 	Origin: stainlessv0.Origin{}, // the zero value of [Origin] is considered omitted
 }
+```
+
+To send `null` instead of a `param.Opt[T]`, use `param.NullOpt[T]()`.
+To send `null` instead of a struct `T`, use `param.NullObj[T]()`.
+
+```go
+params.Description = param.NullOpt[string]() // explicit null string property
+params.Point = param.NullObj[Point]()        // explicit null struct property
+```
+
+Request structs contain a `.WithExtraFields(map[string]any)` method which can send non-conforming
+fields in the request body. Extra fields overwrite any struct fields with a matching
+key. For security reasons, only use `WithExtraFields` with trusted data.
+
+To send a custom value instead of a struct, use `param.OverrideObj[T](value)`.
 
+```go
 // In cases where the API specifies a given type,
 // but you want to send something else, use [WithExtraFields]:
 params.WithExtraFields(map[string]any{
@@ -110,7 +120,7 @@ custom := param.OverrideObj[stainlessv0.FooParams](12)
 ```
 
 When available, use the `.IsPresent()` method to check if an optional parameter is not omitted or `null`.
-Otherwise, the `param.IsOmitted(any)` function can confirm the presence of any `omitzero` field.
+The `param.IsOmitted(any)` function can confirm the presence of any `omitzero` field.
 
 ### Request unions
 
@@ -144,34 +154,38 @@ if address := animal.GetOwner().GetAddress(); address != nil {
 
 ### Response objects
 
-All fields in response structs are value types (not pointers or wrappers).
-
-If a given field is `null`, not present, or invalid, the corresponding field
-will simply be its zero value. To handle optional fields, see the `IsPresent()` method
-below.
-
-All response structs also include a special `JSON` field, containing more detailed
-information about each property, which you can use like so:
+All fields in response structs are ordinary value types (not pointers or wrappers).
+Response structs also include a special `JSON` field containing metadata about
+each property.
 
 ```go
 type Animal struct {
 	Name   string `json:"name,nullable"`
 	Owners int    `json:"owners"`
 	Age    int    `json:"age"`
 	JSON   struct {
-		Name  resp.Field
-		Owner resp.Field
-		Age   resp.Field
+		Name        resp.Field
+		Owner       resp.Field
+		Age         resp.Field
+		ExtraFields map[string]resp.Field
 	} `json:"-"`
 }
+```
+
+To handle optional data, use the `IsPresent()` method on the JSON field.
+If a field is `null`, not present, or invalid, the corresponding field
+will simply be its zero value.
+
+```go
+raw := `{"owners": 1, "name": null}`
 
 var res Animal
-json.Unmarshal([]byte(`{"name": null, "owners": 0}`), &res)
+json.Unmarshal([]byte(raw), &res)
 
 // Use the IsPresent() method to handle optional fields
-res.Owners                  // 0
+res.Owners                  // 1
 res.JSON.Owners.IsPresent() // true
-res.JSON.Owners.Raw()       // "0"
+res.JSON.Owners.Raw()       // "1"
 
 res.Age                  // 0
 res.JSON.Age.IsPresent() // false
@@ -244,7 +258,7 @@ client := stainlessv0.NewClient(
 	option.WithHeader("X-Some-Header", "custom_header_info"),
 )
 
-client.OpenAPI.Get(context.TODO(), ...,
+client.Builds.New(context.TODO(), ...,
 	// Override the header
 	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
 	// Add an undocumented field to the request body, using sjson syntax
@@ -273,14 +287,19 @@ When the API returns a non-success status code, we return an error with type
 To handle errors, we recommend that you use the `errors.As` pattern:
 
 ```go
-_, err := client.OpenAPI.Get(context.TODO())
+_, err := client.Builds.New(context.TODO(), stainlessv0.BuildNewParams{
+	Project: "project",
+	Revision: stainlessv0.BuildNewParamsRevisionUnion{
+		OfString: stainlessv0.String("string"),
+	},
+})
 if err != nil {
 	var apierr *stainlessv0.Error
 	if errors.As(err, &apierr) {
 		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
 		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
 	}
-	panic(err.Error()) // GET "/v0/openapi": 400 Bad Request { ... }
+	panic(err.Error()) // GET "/v0/builds": 400 Bad Request { ... }
 }
 ```
 
@@ -298,8 +317,14 @@ To set a per-retry timeout, use `option.WithRequestTimeout()`.
 // This sets the timeout for the request, including all the retries.
 ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
 defer cancel()
-client.OpenAPI.Get(
+client.Builds.New(
 	ctx,
+	stainlessv0.BuildNewParams{
+		Project: "project",
+		Revision: stainlessv0.BuildNewParamsRevisionUnion{
+			OfString: stainlessv0.String("string"),
+		},
+	},
 	// This sets the per-retry timeout
 	option.WithRequestTimeout(20*time.Second),
 )
@@ -333,7 +358,16 @@ client := stainlessv0.NewClient(
 )
 
 // Override per-request:
-client.OpenAPI.Get(context.TODO(), option.WithMaxRetries(5))
+client.Builds.New(
+	context.TODO(),
+	stainlessv0.BuildNewParams{
+		Project: "project",
+		Revision: stainlessv0.BuildNewParamsRevisionUnion{
+			OfString: stainlessv0.String("string"),
+		},
+	},
+	option.WithMaxRetries(5),
+)
 ```
 
 ### Accessing raw response data (e.g. response headers)
@@ -344,11 +378,20 @@ you need to examine response headers, status codes, or other details.
 ```go
 // Create a variable to store the HTTP response
 var response *http.Response
-openAPI, err := client.OpenAPI.Get(context.TODO(), option.WithResponseInto(&response))
+buildObject, err := client.Builds.New(
+	context.TODO(),
+	stainlessv0.BuildNewParams{
+		Project: "project",
+		Revision: stainlessv0.BuildNewParamsRevisionUnion{
+			OfString: stainlessv0.String("string"),
+		},
+	},
+	option.WithResponseInto(&response),
+)
 if err != nil {
 	// handle error
 }
-fmt.Printf("%+v\n", openAPI)
+fmt.Printf("%+v\n", buildObject)
 
 fmt.Printf("Status Code: %d\n", response.StatusCode)
 fmt.Printf("Headers: %+#v\n", response.Header)