stainless

package module
v0.25.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 22, 2025 License: Apache-2.0 Imports: 20 Imported by: 2

README

Stainless Go API Library

Go Reference

The Stainless Go library provides convenient access to the Stainless REST API from applications written in Go.

It is generated with Stainless.

Installation

import (
	"github.com/stainless-api/stainless-api-go" // imported as stainless
)

Or to pin the version:

go get -u 'github.com/stainless-api/stainless-api-go@v0.25.0'

Requirements

This library requires Go 1.22+.

Usage

The full API of this library can be found in api.md.

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"), // defaults to os.LookupEnv("STAINLESS_API_KEY")
		option.WithEnvironmentStaging(), // defaults to option.WithEnvironmentProduction()
	)
	build, err := client.Builds.New(context.TODO(), stainless.BuildNewParams{
		Project: stainless.String("stainless"),
		Revision: stainless.BuildNewParamsRevisionUnion{
			OfString: stainless.String("main"),
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", build.ID)
}
Request fields

The stainless library uses the omitzero semantics from the Go 1.24+ encoding/json release for request fields.

Required primitive fields (int64, string, etc.) feature the tag `json:"...,required"`. These fields are always serialized, even their zero values.

Optional primitive types are wrapped in a param.Opt[T]. These fields can be set with the provided constructors, stainless.String(string), stainless.Int(int64), etc.

Any param.Opt[T], map, slice, struct or string enum uses the tag `json:"...,omitzero"`. Its zero value is considered omitted.

The param.IsOmitted(any) function can confirm the presence of any omitzero field.

p := stainless.ExampleParams{
	ID:   "id_xxx",                // required property
	Name: stainless.String("..."), // optional property

	Point: stainless.Point{
		X: 0,                // required field will serialize as 0
		Y: stainless.Int(1), // optional field will serialize as 1
		// ... omitted non-required fields will not be serialized
	},

	Origin: stainless.Origin{}, // the zero value of [Origin] is considered omitted
}

To send null instead of a param.Opt[T], use param.Null[T](). To send null instead of a struct T, use param.NullStruct[T]().

p.Name = param.Null[string]()       // 'null' instead of string
p.Point = param.NullStruct[Point]() // 'null' instead of struct

param.IsNull(p.Name)  // true
param.IsNull(p.Point) // true

Request structs contain a .SetExtraFields(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 SetExtraFields with trusted data.

To send a custom value instead of a struct, use param.Override[T](value).

// In cases where the API specifies a given type,
// but you want to send something else, use [SetExtraFields]:
p.SetExtraFields(map[string]any{
	"x": 0.01, // send "x" as a float instead of int
})

// Send a number instead of an object
custom := param.Override[stainless.FooParams](12)
Request unions

Unions are represented as a struct with fields prefixed by "Of" for each of it's variants, only one field can be non-zero. The non-zero field will be serialized.

Sub-properties of the union can be accessed via methods on the union struct. These methods return a mutable pointer to the underlying data, if present.

// Only one field can be non-zero, use param.IsOmitted() to check if a field is set
type AnimalUnionParam struct {
	OfCat *Cat `json:",omitzero,inline`
	OfDog *Dog `json:",omitzero,inline`
}

animal := AnimalUnionParam{
	OfCat: &Cat{
		Name: "Whiskers",
		Owner: PersonParam{
			Address: AddressParam{Street: "3333 Coyote Hill Rd", Zip: 0},
		},
	},
}

// Mutating a field
if address := animal.GetOwner().GetAddress(); address != nil {
	address.ZipCode = 94304
}
Response objects

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.

type Animal struct {
	Name   string `json:"name,nullable"`
	Owners int    `json:"owners"`
	Age    int    `json:"age"`
	JSON   struct {
		Name        respjson.Field
		Owner       respjson.Field
		Age         respjson.Field
		ExtraFields map[string]respjson.Field
	} `json:"-"`
}

To handle optional data, use the .Valid() method on the JSON field. .Valid() returns true if a field is not null, not present, or couldn't be marshaled.

If .Valid() is false, the corresponding field will simply be its zero value.

raw := `{"owners": 1, "name": null}`

var res Animal
json.Unmarshal([]byte(raw), &res)

// Accessing regular fields

res.Owners // 1
res.Name   // ""
res.Age    // 0

// Optional field checks

res.JSON.Owners.Valid() // true
res.JSON.Name.Valid()   // false
res.JSON.Age.Valid()    // false

// Raw JSON values

res.JSON.Owners.Raw()                  // "1"
res.JSON.Name.Raw() == "null"          // true
res.JSON.Name.Raw() == respjson.Null   // true
res.JSON.Age.Raw() == ""               // true
res.JSON.Age.Raw() == respjson.Omitted // true

These .JSON structs also include an ExtraFields map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
Response Unions

In responses, unions are represented by a flattened struct containing all possible fields from each of the object variants. To convert it to a variant use the .AsFooVariant() method or the .AsAny() method if present.

If a response value union contains primitive values, primitive fields will be alongside the properties but prefixed with Of and feature the tag json:"...,inline".

type AnimalUnion struct {
	// From variants [Dog], [Cat]
	Owner Person `json:"owner"`
	// From variant [Dog]
	DogBreed string `json:"dog_breed"`
	// From variant [Cat]
	CatBreed string `json:"cat_breed"`
	// ...

	JSON struct {
		Owner respjson.Field
		// ...
	} `json:"-"`
}

// If animal variant
if animal.Owner.Address.ZipCode == "" {
	panic("missing zip code")
}

// Switch on the variant
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
	panic("unexpected type")
}
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := stainless.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

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
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

The request option option.WithDebugLog(nil) may be helpful while debugging.

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

iter := client.Builds.ListAutoPaging(context.TODO(), stainless.BuildListParams{
	Project: stainless.String("stainless"),
})
// Automatically fetches more pages as needed.
for iter.Next() {
	build := iter.Current()
	fmt.Printf("%+v\n", build)
}
if err := iter.Err(); err != nil {
	panic(err.Error())
}

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

page, err := client.Builds.List(context.TODO(), stainless.BuildListParams{
	Project: stainless.String("stainless"),
})
for page != nil {
	for _, build := range page.Data {
		fmt.Printf("%+v\n", build)
	}
	page, err = page.GetNextPage()
}
if err != nil {
	panic(err.Error())
}
Errors

When the API returns a non-success status code, we return an error with type *stainless.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Builds.New(context.TODO(), stainless.BuildNewParams{
	Project: stainless.String("stainless"),
	Revision: stainless.BuildNewParamsRevisionUnion{
		OfString: stainless.String("main"),
	},
})
if err != nil {
	var apierr *stainless.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/builds": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. 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.Builds.New(
	ctx,
	stainless.BuildNewParams{
		Project: stainless.String("stainless"),
		Revision: stainless.BuildNewParamsRevisionUnion{
			OfString: stainless.String("main"),
		},
	},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as io.Reader. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper stainless.File(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := stainless.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Builds.New(
	context.TODO(),
	stainless.BuildNewParams{
		Project: stainless.String("stainless"),
		Revision: stainless.BuildNewParamsRevisionUnion{
			OfString: stainless.String("main"),
		},
	},
	option.WithMaxRetries(5),
)
Accessing raw response data (e.g. response headers)

You can access the raw HTTP response data by using the option.WithResponseInto() request option. This is useful when you need to examine response headers, status codes, or other details.

// Create a variable to store the HTTP response
var response *http.Response
build, err := client.Builds.New(
	context.TODO(),
	stainless.BuildNewParams{
		Project: stainless.String("stainless"),
		Revision: stainless.BuildNewParamsRevisionUnion{
			OfString: stainless.String("main"),
		},
	},
	option.WithResponseInto(&response),
)
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", build)

fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]any

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   "id_xxxx",
    Data: FooNewParamsData{
        FirstName: stainless.String("John"),
    },
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := stainless.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

View Source 
const TargetCli = shared.TargetCli

Equals "cli"

View Source 
const TargetCsharp = shared.TargetCsharp

Equals "csharp"

View Source 
const TargetGo = shared.TargetGo

Equals "go"

View Source 
const TargetJava = shared.TargetJava

Equals "java"

View Source 
const TargetKotlin = shared.TargetKotlin

Equals "kotlin"

View Source 
const TargetNode = shared.TargetNode

Equals "node"

View Source 
const TargetPhp = shared.TargetPhp

Equals "php"

View Source 
const TargetPython = shared.TargetPython

Equals "python"

View Source 
const TargetRuby = shared.TargetRuby

Equals "ruby"

View Source 
const TargetTerraform = shared.TargetTerraform

Equals "terraform"

View Source 
const TargetTypescript = shared.TargetTypescript

Equals "typescript"

Variables

This section is empty.

Functions

func Bool 

func Bool(b bool) param.Opt[bool]

func BoolPtr added in v0.1.1 

func BoolPtr(v bool) *bool

func DefaultClientOptions 

func DefaultClientOptions() []option.RequestOption

DefaultClientOptions read from the environment (STAINLESS_API_KEY, STAINLESS_BASE_URL). This should be used to initialize new clients.

func File added in v0.1.1 

func File(rdr io.Reader, filename string, contentType string) file

func Float 

func Float(f float64) param.Opt[float64]

func FloatPtr added in v0.1.1 

func FloatPtr(v float64) *float64

func Int 

func Int(i int64) param.Opt[int64]

func IntPtr added in v0.1.1 

func IntPtr(v int64) *int64

func Opt added in v0.1.1 

func Opt[T comparable](v T) param.Opt[T]

func Ptr added in v0.1.1 

func Ptr[T any](v T) *T

func String 

func String(s string) param.Opt[string]

func StringPtr added in v0.1.1 

func StringPtr(v string) *string

func Time added in v0.1.1 

func Time(t time.Time) param.Opt[time.Time]

func TimePtr added in v0.1.1 

func TimePtr(v time.Time) *time.Time

Types

type Build 

type Build struct {
	// Build ID
	ID             string                   `json:"id,required"`
	ConfigCommit   string                   `json:"config_commit,required"`
	CreatedAt      time.Time                `json:"created_at,required" format:"date-time"`
	DocumentedSpec BuildDocumentedSpecUnion `json:"documented_spec,required"`
	// Any of "build".
	Object    BuildObject  `json:"object,required"`
	Org       string       `json:"org,required"`
	Project   string       `json:"project,required"`
	Targets   BuildTargets `json:"targets,required"`
	UpdatedAt time.Time    `json:"updated_at,required" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		ConfigCommit   respjson.Field
		CreatedAt      respjson.Field
		DocumentedSpec respjson.Field
		Object         respjson.Field
		Org            respjson.Field
		Project        respjson.Field
		Targets        respjson.Field
		UpdatedAt      respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (Build) RawJSON added in v0.25.0 

func (r Build) RawJSON() string

Returns the unmodified JSON received from the API

func (*Build) UnmarshalJSON 

func (r *Build) UnmarshalJSON(data []byte) error

type BuildCompareParams added in v0.4.0 

type BuildCompareParams struct {
	// Project name
	Project param.Opt[string] `json:"project,omitzero,required"`
	// Parameters for the base build
	Base BuildCompareParamsBase `json:"base,omitzero,required"`
	// Parameters for the head build
	Head BuildCompareParamsHead `json:"head,omitzero,required"`
	// Optional list of SDK targets to build. If not specified, all configured targets
	// will be built.
	Targets []shared.Target `json:"targets,omitzero"`
	// contains filtered or unexported fields
}

func (BuildCompareParams) MarshalJSON added in v0.4.0 

func (r BuildCompareParams) MarshalJSON() (data []byte, err error)

func (*BuildCompareParams) UnmarshalJSON added in v0.4.0 

func (r *BuildCompareParams) UnmarshalJSON(data []byte) error

type BuildCompareParamsBase added in v0.4.0 

type BuildCompareParamsBase struct {
	// Branch to use. When using a branch name as revision, this must match or be
	// omitted.
	Branch string `json:"branch,required"`
	// Specifies what to build: a branch name, a commit SHA, or file contents.
	Revision BuildCompareParamsBaseRevisionUnion `json:"revision,omitzero,required"`
	// Optional commit message to use when creating a new commit.
	CommitMessage param.Opt[string] `json:"commit_message,omitzero"`
	// contains filtered or unexported fields
}

Parameters for the base build

The properties Branch, Revision are required.

func (BuildCompareParamsBase) MarshalJSON added in v0.4.0 

func (r BuildCompareParamsBase) MarshalJSON() (data []byte, err error)

func (*BuildCompareParamsBase) UnmarshalJSON added in v0.4.0 

func (r *BuildCompareParamsBase) UnmarshalJSON(data []byte) error

type BuildCompareParamsBaseRevisionUnion added in v0.4.0 

type BuildCompareParamsBaseRevisionUnion struct {
	OfString       param.Opt[string]                     `json:",omitzero,inline"`
	OfFileInputMap map[string]shared.FileInputUnionParam `json:",omitzero,inline"`
	// contains filtered or unexported fields
}

Only one field can be non-zero.

Use param.IsOmitted to confirm if a field is set.

func (BuildCompareParamsBaseRevisionUnion) MarshalJSON added in v0.4.0 

func (u BuildCompareParamsBaseRevisionUnion) MarshalJSON() ([]byte, error)

func (*BuildCompareParamsBaseRevisionUnion) UnmarshalJSON added in v0.4.0 

func (u *BuildCompareParamsBaseRevisionUnion) UnmarshalJSON(data []byte) error

type BuildCompareParamsHead added in v0.4.0 

type BuildCompareParamsHead struct {
	// Branch to use. When using a branch name as revision, this must match or be
	// omitted.
	Branch string `json:"branch,required"`
	// Specifies what to build: a branch name, a commit SHA, or file contents.
	Revision BuildCompareParamsHeadRevisionUnion `json:"revision,omitzero,required"`
	// Optional commit message to use when creating a new commit.
	CommitMessage param.Opt[string] `json:"commit_message,omitzero"`
	// contains filtered or unexported fields
}

Parameters for the head build

The properties Branch, Revision are required.

func (BuildCompareParamsHead) MarshalJSON added in v0.4.0 

func (r BuildCompareParamsHead) MarshalJSON() (data []byte, err error)

func (*BuildCompareParamsHead) UnmarshalJSON added in v0.4.0 

func (r *BuildCompareParamsHead) UnmarshalJSON(data []byte) error

type BuildCompareParamsHeadRevisionUnion added in v0.4.0 

type BuildCompareParamsHeadRevisionUnion struct {
	OfString       param.Opt[string]                     `json:",omitzero,inline"`
	OfFileInputMap map[string]shared.FileInputUnionParam `json:",omitzero,inline"`
	// contains filtered or unexported fields
}

Only one field can be non-zero.

Use param.IsOmitted to confirm if a field is set.

func (BuildCompareParamsHeadRevisionUnion) MarshalJSON added in v0.4.0 

func (u BuildCompareParamsHeadRevisionUnion) MarshalJSON() ([]byte, error)

func (*BuildCompareParamsHeadRevisionUnion) UnmarshalJSON added in v0.4.0 

func (u *BuildCompareParamsHeadRevisionUnion) UnmarshalJSON(data []byte) error

type BuildCompareResponse added in v0.4.0 

type BuildCompareResponse struct {
	Base Build `json:"base,required"`
	Head Build `json:"head,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Base        respjson.Field
		Head        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildCompareResponse) RawJSON added in v0.4.0 

func (r BuildCompareResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildCompareResponse) UnmarshalJSON added in v0.4.0 

func (r *BuildCompareResponse) UnmarshalJSON(data []byte) error

type BuildDiagnostic added in v0.25.0 

type BuildDiagnostic struct {
	// The kind of diagnostic.
	Code string `json:"code,required"`
	// Whether the diagnostic is ignored in the Stainless config.
	Ignored bool `json:"ignored,required"`
	// The severity of the diagnostic.
	//
	// Any of "fatal", "error", "warning", "note".
	Level BuildDiagnosticLevel `json:"level,required"`
	// A description of the diagnostic.
	Message string                   `json:"message,required"`
	More    BuildDiagnosticMoreUnion `json:"more,required"`
	// A JSON pointer to a relevant field in the Stainless config.
	ConfigRef string `json:"config_ref"`
	// A JSON pointer to a relevant field in the OpenAPI spec.
	OasRef string `json:"oas_ref"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Code        respjson.Field
		Ignored     respjson.Field
		Level       respjson.Field
		Message     respjson.Field
		More        respjson.Field
		ConfigRef   respjson.Field
		OasRef      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildDiagnostic) RawJSON added in v0.25.0 

func (r BuildDiagnostic) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildDiagnostic) UnmarshalJSON added in v0.25.0 

func (r *BuildDiagnostic) UnmarshalJSON(data []byte) error

type BuildDiagnosticLevel added in v0.25.0 

type BuildDiagnosticLevel string

The severity of the diagnostic. 

const (
	BuildDiagnosticLevelFatal   BuildDiagnosticLevel = "fatal"
	BuildDiagnosticLevelError   BuildDiagnosticLevel = "error"
	BuildDiagnosticLevelWarning BuildDiagnosticLevel = "warning"
	BuildDiagnosticLevelNote    BuildDiagnosticLevel = "note"
)

type BuildDiagnosticListParams added in v0.10.0 

type BuildDiagnosticListParams struct {
	// Pagination cursor from a previous response
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of diagnostics to return, defaults to 100 (maximum: 100)
	Limit param.Opt[float64] `query:"limit,omitzero" json:"-"`
	// Includes the given severity and above (fatal > error > warning > note).
	//
	// Any of "fatal", "error", "warning", "note".
	Severity BuildDiagnosticListParamsSeverity `query:"severity,omitzero" json:"-"`
	// Optional list of language targets to filter diagnostics by
	Targets []shared.Target `query:"targets,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BuildDiagnosticListParams) URLQuery added in v0.10.0 

func (r BuildDiagnosticListParams) URLQuery() (v url.Values, err error)

URLQuery serializes BuildDiagnosticListParams's query parameters as `url.Values`.

type BuildDiagnosticListParamsSeverity added in v0.10.0 

type BuildDiagnosticListParamsSeverity string

Includes the given severity and above (fatal > error > warning > note). 

const (
	BuildDiagnosticListParamsSeverityFatal   BuildDiagnosticListParamsSeverity = "fatal"
	BuildDiagnosticListParamsSeverityError   BuildDiagnosticListParamsSeverity = "error"
	BuildDiagnosticListParamsSeverityWarning BuildDiagnosticListParamsSeverity = "warning"
	BuildDiagnosticListParamsSeverityNote    BuildDiagnosticListParamsSeverity = "note"
)

type BuildDiagnosticMoreMarkdown added in v0.25.0 

type BuildDiagnosticMoreMarkdown struct {
	Markdown string            `json:"markdown,required"`
	Type     constant.Markdown `json:"type,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Markdown    respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildDiagnosticMoreMarkdown) RawJSON added in v0.25.0 

func (r BuildDiagnosticMoreMarkdown) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildDiagnosticMoreMarkdown) UnmarshalJSON added in v0.25.0 

func (r *BuildDiagnosticMoreMarkdown) UnmarshalJSON(data []byte) error

type BuildDiagnosticMoreRaw added in v0.25.0 

type BuildDiagnosticMoreRaw struct {
	Raw  string       `json:"raw,required"`
	Type constant.Raw `json:"type,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Raw         respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildDiagnosticMoreRaw) RawJSON added in v0.25.0 

func (r BuildDiagnosticMoreRaw) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildDiagnosticMoreRaw) UnmarshalJSON added in v0.25.0 

func (r *BuildDiagnosticMoreRaw) UnmarshalJSON(data []byte) error

type BuildDiagnosticMoreUnion added in v0.25.0 

type BuildDiagnosticMoreUnion struct {
	// This field is from variant [BuildDiagnosticMoreMarkdown].
	Markdown string `json:"markdown"`
	// Any of "markdown", "raw".
	Type string `json:"type"`
	// This field is from variant [BuildDiagnosticMoreRaw].
	Raw  string `json:"raw"`
	JSON struct {
		Markdown respjson.Field
		Type     respjson.Field
		Raw      respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

BuildDiagnosticMoreUnion contains all possible properties and values from BuildDiagnosticMoreMarkdown, BuildDiagnosticMoreRaw.

Use the BuildDiagnosticMoreUnion.AsAny method to switch on the variant.

Use the methods beginning with 'As' to cast the union to one of its variants.

func (BuildDiagnosticMoreUnion) AsAny added in v0.25.0 

func (u BuildDiagnosticMoreUnion) AsAny() anyBuildDiagnosticMore

Use the following switch statement to find the correct variant 

switch variant := BuildDiagnosticMoreUnion.AsAny().(type) {
case stainless.BuildDiagnosticMoreMarkdown:
case stainless.BuildDiagnosticMoreRaw:
default:
  fmt.Errorf("no variant present")
}

func (BuildDiagnosticMoreUnion) AsMarkdown added in v0.25.0 

func (u BuildDiagnosticMoreUnion) AsMarkdown() (v BuildDiagnosticMoreMarkdown)

func (BuildDiagnosticMoreUnion) AsRaw added in v0.25.0 

func (u BuildDiagnosticMoreUnion) AsRaw() (v BuildDiagnosticMoreRaw)

func (BuildDiagnosticMoreUnion) RawJSON added in v0.25.0 

func (u BuildDiagnosticMoreUnion) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildDiagnosticMoreUnion) UnmarshalJSON added in v0.25.0 

func (r *BuildDiagnosticMoreUnion) UnmarshalJSON(data []byte) error

type BuildDiagnosticService added in v0.10.0 

type BuildDiagnosticService struct {
	Options []option.RequestOption
}

BuildDiagnosticService contains methods and other services that help with interacting with the stainless API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBuildDiagnosticService method instead.

func NewBuildDiagnosticService added in v0.10.0 

func NewBuildDiagnosticService(opts ...option.RequestOption) (r BuildDiagnosticService)

NewBuildDiagnosticService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BuildDiagnosticService) List added in v0.10.0 

func (r *BuildDiagnosticService) List(ctx context.Context, buildID string, query BuildDiagnosticListParams, opts ...option.RequestOption) (res *pagination.Page[BuildDiagnostic], err error)

Get the list of diagnostics for a given build.

If no language targets are specified, diagnostics for all languages are returned.

func (*BuildDiagnosticService) ListAutoPaging added in v0.13.0 

func (r *BuildDiagnosticService) ListAutoPaging(ctx context.Context, buildID string, query BuildDiagnosticListParams, opts ...option.RequestOption) *pagination.PageAutoPager[BuildDiagnostic]

Get the list of diagnostics for a given build.

If no language targets are specified, diagnostics for all languages are returned.

type BuildDocumentedSpecObject added in v0.25.0 

type BuildDocumentedSpecObject struct {
	Content string `json:"content,required"`
	// Any of "content".
	Type string `json:"type,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Content     respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildDocumentedSpecObject) RawJSON added in v0.25.0 

func (r BuildDocumentedSpecObject) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildDocumentedSpecObject) UnmarshalJSON added in v0.25.0 

func (r *BuildDocumentedSpecObject) UnmarshalJSON(data []byte) error

type BuildDocumentedSpecUnion added in v0.25.0 

type BuildDocumentedSpecUnion struct {
	// This field is from variant [BuildDocumentedSpecObject].
	Content string `json:"content"`
	// This field is from variant [BuildDocumentedSpecObject].
	Type string `json:"type"`
	// This field is from variant [BuildDocumentedSpecObject].
	Expires time.Time `json:"expires"`
	// This field is from variant [BuildDocumentedSpecObject].
	URL  string `json:"url"`
	JSON struct {
		Content respjson.Field
		Type    respjson.Field
		Expires respjson.Field
		URL     respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

BuildDocumentedSpecUnion contains all possible properties and values from BuildDocumentedSpecObject, BuildDocumentedSpecObject.

Use the methods beginning with 'As' to cast the union to one of its variants.

func (BuildDocumentedSpecUnion) AsBuildDocumentedSpecObject added in v0.25.0 

func (u BuildDocumentedSpecUnion) AsBuildDocumentedSpecObject() (v BuildDocumentedSpecObject)

func (BuildDocumentedSpecUnion) AsVariant2 added in v0.25.0 

func (u BuildDocumentedSpecUnion) AsVariant2() (v BuildDocumentedSpecObject)

func (BuildDocumentedSpecUnion) RawJSON added in v0.25.0 

func (u BuildDocumentedSpecUnion) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildDocumentedSpecUnion) UnmarshalJSON added in v0.25.0 

func (r *BuildDocumentedSpecUnion) UnmarshalJSON(data []byte) error

type BuildListParams added in v0.1.1 

type BuildListParams struct {
	// Project name
	//
	// Use [option.WithProject] on the client to set a global default for this field.
	Project param.Opt[string] `query:"project,omitzero,required" json:"-"`
	// Branch name
	Branch param.Opt[string] `query:"branch,omitzero" json:"-"`
	// Pagination cursor from a previous response.
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of builds to return, defaults to 10 (maximum: 100).
	Limit param.Opt[float64] `query:"limit,omitzero" json:"-"`
	// A config commit SHA used for the build
	Revision BuildListParamsRevisionUnion `query:"revision,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BuildListParams) URLQuery added in v0.1.1 

func (r BuildListParams) URLQuery() (v url.Values, err error)

URLQuery serializes BuildListParams's query parameters as `url.Values`.

type BuildListParamsRevisionMapItem added in v0.2.0 

type BuildListParamsRevisionMapItem struct {
	// File content hash
	Hash string `query:"hash,required" json:"-"`
	// contains filtered or unexported fields
}

The property Hash is required.

func (BuildListParamsRevisionMapItem) URLQuery added in v0.2.0 

func (r BuildListParamsRevisionMapItem) URLQuery() (v url.Values, err error)

URLQuery serializes BuildListParamsRevisionMapItem's query parameters as `url.Values`.

type BuildListParamsRevisionUnion added in v0.2.0 

type BuildListParamsRevisionUnion struct {
	OfString                   param.Opt[string]                         `query:",omitzero,inline"`
	OfBuildListsRevisionMapMap map[string]BuildListParamsRevisionMapItem `query:",omitzero,inline"`
	// contains filtered or unexported fields
}

Only one field can be non-zero.

Use param.IsOmitted to confirm if a field is set.

type BuildNewParams 

type BuildNewParams struct {
	// Project name
	Project param.Opt[string] `json:"project,omitzero,required"`
	// Specifies what to build: a branch name, commit SHA, merge command
	// ("base..head"), or file contents.
	Revision BuildNewParamsRevisionUnion `json:"revision,omitzero,required"`
	// Whether to allow empty commits (no changes). Defaults to false.
	AllowEmpty param.Opt[bool] `json:"allow_empty,omitzero"`
	// The project branch to use for the build. If not specified, the branch is
	// inferred from the `revision`, and will 400 when that is not possible.
	Branch param.Opt[string] `json:"branch,omitzero"`
	// Optional commit message to use when creating a new commit.
	CommitMessage param.Opt[string] `json:"commit_message,omitzero"`
	// Optional list of SDK targets to build. If not specified, all configured targets
	// will be built.
	Targets []shared.Target `json:"targets,omitzero"`
	// contains filtered or unexported fields
}

func (BuildNewParams) MarshalJSON 

func (r BuildNewParams) MarshalJSON() (data []byte, err error)

func (*BuildNewParams) UnmarshalJSON added in v0.4.0 

func (r *BuildNewParams) UnmarshalJSON(data []byte) error

type BuildNewParamsRevisionUnion added in v0.1.1 

type BuildNewParamsRevisionUnion struct {
	OfString       param.Opt[string]                     `json:",omitzero,inline"`
	OfFileInputMap map[string]shared.FileInputUnionParam `json:",omitzero,inline"`
	// contains filtered or unexported fields
}

Only one field can be non-zero.

Use param.IsOmitted to confirm if a field is set.

func (BuildNewParamsRevisionUnion) MarshalJSON added in v0.1.1 

func (u BuildNewParamsRevisionUnion) MarshalJSON() ([]byte, error)

func (*BuildNewParamsRevisionUnion) UnmarshalJSON added in v0.4.0 

func (u *BuildNewParamsRevisionUnion) UnmarshalJSON(data []byte) error

type BuildObject 

type BuildObject string
const (
	BuildObjectBuild BuildObject = "build"
)

type BuildService 

type BuildService struct {
	Options       []option.RequestOption
	Diagnostics   BuildDiagnosticService
	TargetOutputs BuildTargetOutputService
}

BuildService contains methods and other services that help with interacting with the stainless API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBuildService method instead.

func NewBuildService 

func NewBuildService(opts ...option.RequestOption) (r BuildService)

NewBuildService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BuildService) Compare added in v0.4.0 

func (r *BuildService) Compare(ctx context.Context, body BuildCompareParams, opts ...option.RequestOption) (res *BuildCompareResponse, err error)

Create two builds whose outputs can be directly compared with each other.

Created builds _modify_ their project branches so that their latest sets of config files point to the ones specified by the input revision.

This endpoint is useful because a build has more inputs than the set of config files it uses, so comparing two builds directly may return spurious differences. Builds made via this endpoint are guaranteed to have differences arising from the set of config files, and any custom code.

func (*BuildService) Get 

func (r *BuildService) Get(ctx context.Context, buildID string, opts ...option.RequestOption) (res *Build, err error)

Retrieve a build by its ID.

func (*BuildService) List added in v0.1.1 

func (r *BuildService) List(ctx context.Context, query BuildListParams, opts ...option.RequestOption) (res *pagination.Page[Build], err error)

List user-triggered builds for a given project.

An optional revision can be specified to filter by config commit SHA, or hashes of file contents.

func (*BuildService) ListAutoPaging added in v0.13.0 

func (r *BuildService) ListAutoPaging(ctx context.Context, query BuildListParams, opts ...option.RequestOption) *pagination.PageAutoPager[Build]

List user-triggered builds for a given project.

An optional revision can be specified to filter by config commit SHA, or hashes of file contents.

func (*BuildService) New 

func (r *BuildService) New(ctx context.Context, body BuildNewParams, opts ...option.RequestOption) (res *Build, err error)

Create a build, on top of a project branch, against a given input revision.

The project branch will be modified so that its latest set of config files points to the one specified by the input revision.

type BuildTarget 

type BuildTarget struct {
	Commit     BuildTargetCommitUnion `json:"commit,required"`
	InstallURL string                 `json:"install_url,required"`
	Lint       CheckStepUnion         `json:"lint,required"`
	// Any of "build_target".
	Object BuildTargetObject `json:"object,required"`
	// Any of "not_started", "codegen", "postgen", "completed".
	Status BuildTargetStatus `json:"status,required"`
	Test   CheckStepUnion    `json:"test,required"`
	Build  CheckStepUnion    `json:"build"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Commit      respjson.Field
		InstallURL  respjson.Field
		Lint        respjson.Field
		Object      respjson.Field
		Status      respjson.Field
		Test        respjson.Field
		Build       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTarget) RawJSON added in v0.1.1 

func (r BuildTarget) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTarget) UnmarshalJSON 

func (r *BuildTarget) UnmarshalJSON(data []byte) error

type BuildTargetCommitCompleted added in v0.1.1 

type BuildTargetCommitCompleted struct {
	Completed BuildTargetCommitCompletedCompleted `json:"completed,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
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetCommitCompleted) RawJSON added in v0.1.1 

func (r BuildTargetCommitCompleted) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitCompleted) UnmarshalJSON added in v0.1.1 

func (r *BuildTargetCommitCompleted) UnmarshalJSON(data []byte) error

type BuildTargetCommitCompletedCompleted added in v0.1.1 

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"`
	MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr `json:"merge_conflict_pr,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Commit          respjson.Field
		Conclusion      respjson.Field
		MergeConflictPr respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetCommitCompletedCompleted) RawJSON added in v0.1.1 

func (r BuildTargetCommitCompletedCompleted) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitCompletedCompleted) UnmarshalJSON added in v0.1.1 

func (r *BuildTargetCommitCompletedCompleted) UnmarshalJSON(data []byte) error

type BuildTargetCommitCompletedCompletedMergeConflictPr added in v0.1.1 

type BuildTargetCommitCompletedCompletedMergeConflictPr struct {
	Number float64                                                `json:"number,required"`
	Repo   BuildTargetCommitCompletedCompletedMergeConflictPrRepo `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
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetCommitCompletedCompletedMergeConflictPr) RawJSON added in v0.1.1 

func (r BuildTargetCommitCompletedCompletedMergeConflictPr) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitCompletedCompletedMergeConflictPr) UnmarshalJSON added in v0.1.1 

func (r *BuildTargetCommitCompletedCompletedMergeConflictPr) UnmarshalJSON(data []byte) error

type BuildTargetCommitCompletedCompletedMergeConflictPrRepo added in v0.1.1 

type BuildTargetCommitCompletedCompletedMergeConflictPrRepo 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
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetCommitCompletedCompletedMergeConflictPrRepo) RawJSON added in v0.1.1 

func (r BuildTargetCommitCompletedCompletedMergeConflictPrRepo) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitCompletedCompletedMergeConflictPrRepo) UnmarshalJSON added in v0.1.1 

func (r *BuildTargetCommitCompletedCompletedMergeConflictPrRepo) UnmarshalJSON(data []byte) error

type BuildTargetCommitInProgress added in v0.1.1 

type BuildTargetCommitInProgress struct {
	Status constant.InProgress `json:"status,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetCommitInProgress) RawJSON added in v0.1.1 

func (r BuildTargetCommitInProgress) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitInProgress) UnmarshalJSON added in v0.1.1 

func (r *BuildTargetCommitInProgress) UnmarshalJSON(data []byte) error

type BuildTargetCommitNotStarted added in v0.1.1 

type BuildTargetCommitNotStarted struct {
	Status constant.NotStarted `json:"status,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetCommitNotStarted) RawJSON added in v0.1.1 

func (r BuildTargetCommitNotStarted) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitNotStarted) UnmarshalJSON added in v0.1.1 

func (r *BuildTargetCommitNotStarted) UnmarshalJSON(data []byte) error

type BuildTargetCommitQueued added in v0.1.1 

type BuildTargetCommitQueued struct {
	Status constant.Queued `json:"status,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetCommitQueued) RawJSON added in v0.1.1 

func (r BuildTargetCommitQueued) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitQueued) UnmarshalJSON added in v0.1.1 

func (r *BuildTargetCommitQueued) UnmarshalJSON(data []byte) error

type BuildTargetCommitUnion 

type BuildTargetCommitUnion struct {
	// Any of "not_started", "queued", "in_progress", "completed".
	Status string `json:"status"`
	// This field is from variant [BuildTargetCommitCompleted].
	Completed BuildTargetCommitCompletedCompleted `json:"completed"`
	JSON      struct {
		Status    respjson.Field
		Completed respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

BuildTargetCommitUnion contains all possible properties and values from BuildTargetCommitNotStarted, BuildTargetCommitQueued, BuildTargetCommitInProgress, BuildTargetCommitCompleted.

Use the BuildTargetCommitUnion.AsAny method to switch on the variant.

Use the methods beginning with 'As' to cast the union to one of its variants.

func (BuildTargetCommitUnion) AsAny added in v0.1.1 

func (u BuildTargetCommitUnion) AsAny() anyBuildTargetCommit

Use the following switch statement to find the correct variant 

switch variant := BuildTargetCommitUnion.AsAny().(type) {
case stainless.BuildTargetCommitNotStarted:
case stainless.BuildTargetCommitQueued:
case stainless.BuildTargetCommitInProgress:
case stainless.BuildTargetCommitCompleted:
default:
  fmt.Errorf("no variant present")
}

func (BuildTargetCommitUnion) AsCompleted added in v0.1.1 

func (u BuildTargetCommitUnion) AsCompleted() (v BuildTargetCommitCompleted)

func (BuildTargetCommitUnion) AsInProgress added in v0.1.1 

func (u BuildTargetCommitUnion) AsInProgress() (v BuildTargetCommitInProgress)

func (BuildTargetCommitUnion) AsNotStarted added in v0.1.1 

func (u BuildTargetCommitUnion) AsNotStarted() (v BuildTargetCommitNotStarted)

func (BuildTargetCommitUnion) AsQueued added in v0.1.1 

func (u BuildTargetCommitUnion) AsQueued() (v BuildTargetCommitQueued)

func (BuildTargetCommitUnion) RawJSON added in v0.1.1 

func (u BuildTargetCommitUnion) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitUnion) UnmarshalJSON added in v0.1.1 

func (r *BuildTargetCommitUnion) UnmarshalJSON(data []byte) error

type BuildTargetObject 

type BuildTargetObject string
const (
	BuildTargetObjectBuildTarget BuildTargetObject = "build_target"
)

type BuildTargetOutputGetParams added in v0.2.0 

type BuildTargetOutputGetParams struct {
	// Build ID
	BuildID string `query:"build_id,required" json:"-"`
	// SDK language target name
	//
	// Any of "node", "typescript", "python", "go", "java", "kotlin", "ruby",
	// "terraform", "cli", "php", "csharp".
	Target BuildTargetOutputGetParamsTarget `query:"target,omitzero,required" json:"-"`
	// Any of "source", "dist", "wheel".
	Type BuildTargetOutputGetParamsType `query:"type,omitzero,required" json:"-"`
	// Output format: url (download URL) or git (temporary access token).
	//
	// Any of "url", "git".
	Output BuildTargetOutputGetParamsOutput `query:"output,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (BuildTargetOutputGetParams) URLQuery added in v0.2.0 

func (r BuildTargetOutputGetParams) URLQuery() (v url.Values, err error)

URLQuery serializes BuildTargetOutputGetParams's query parameters as `url.Values`.

type BuildTargetOutputGetParamsOutput added in v0.2.0 

type BuildTargetOutputGetParamsOutput string

Output format: url (download URL) or git (temporary access token). 

const (
	BuildTargetOutputGetParamsOutputURL BuildTargetOutputGetParamsOutput = "url"
	BuildTargetOutputGetParamsOutputGit BuildTargetOutputGetParamsOutput = "git"
)

type BuildTargetOutputGetParamsTarget added in v0.2.0 

type BuildTargetOutputGetParamsTarget string

SDK language target name 

const (
	BuildTargetOutputGetParamsTargetNode       BuildTargetOutputGetParamsTarget = "node"
	BuildTargetOutputGetParamsTargetTypescript BuildTargetOutputGetParamsTarget = "typescript"
	BuildTargetOutputGetParamsTargetPython     BuildTargetOutputGetParamsTarget = "python"
	BuildTargetOutputGetParamsTargetGo         BuildTargetOutputGetParamsTarget = "go"
	BuildTargetOutputGetParamsTargetJava       BuildTargetOutputGetParamsTarget = "java"
	BuildTargetOutputGetParamsTargetKotlin     BuildTargetOutputGetParamsTarget = "kotlin"
	BuildTargetOutputGetParamsTargetRuby       BuildTargetOutputGetParamsTarget = "ruby"
	BuildTargetOutputGetParamsTargetTerraform  BuildTargetOutputGetParamsTarget = "terraform"
	BuildTargetOutputGetParamsTargetCli        BuildTargetOutputGetParamsTarget = "cli"
	BuildTargetOutputGetParamsTargetPhp        BuildTargetOutputGetParamsTarget = "php"
	BuildTargetOutputGetParamsTargetCsharp     BuildTargetOutputGetParamsTarget = "csharp"
)

type BuildTargetOutputGetParamsType added in v0.2.0 

type BuildTargetOutputGetParamsType string
const (
	BuildTargetOutputGetParamsTypeSource BuildTargetOutputGetParamsType = "source"
	BuildTargetOutputGetParamsTypeDist   BuildTargetOutputGetParamsType = "dist"
	BuildTargetOutputGetParamsTypeWheel  BuildTargetOutputGetParamsType = "wheel"
)

type BuildTargetOutputGetResponseGit added in v0.25.0 

type BuildTargetOutputGetResponseGit struct {
	// Temporary GitHub access token
	Token  string       `json:"token,required"`
	Output constant.Git `json:"output,required"`
	// Git reference (commit SHA, branch, or tag)
	Ref string `json:"ref,required"`
	// Any of "node", "typescript", "python", "go", "java", "kotlin", "ruby",
	// "terraform", "cli", "php", "csharp".
	Target shared.Target `json:"target,required"`
	// Any of "source", "dist", "wheel".
	Type BuildTargetOutputGetResponseGitType `json:"type,required"`
	// URL to git remote
	URL string `json:"url,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Token       respjson.Field
		Output      respjson.Field
		Ref         respjson.Field
		Target      respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetOutputGetResponseGit) RawJSON added in v0.25.0 

func (r BuildTargetOutputGetResponseGit) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetOutputGetResponseGit) UnmarshalJSON added in v0.25.0 

func (r *BuildTargetOutputGetResponseGit) UnmarshalJSON(data []byte) error

type BuildTargetOutputGetResponseGitType added in v0.25.0 

type BuildTargetOutputGetResponseGitType string
const (
	BuildTargetOutputGetResponseGitTypeSource BuildTargetOutputGetResponseGitType = "source"
	BuildTargetOutputGetResponseGitTypeDist   BuildTargetOutputGetResponseGitType = "dist"
	BuildTargetOutputGetResponseGitTypeWheel  BuildTargetOutputGetResponseGitType = "wheel"
)

type BuildTargetOutputGetResponseType added in v0.14.0 

type BuildTargetOutputGetResponseType string
const (
	BuildTargetOutputGetResponseTypeSource BuildTargetOutputGetResponseType = "source"
	BuildTargetOutputGetResponseTypeDist   BuildTargetOutputGetResponseType = "dist"
	BuildTargetOutputGetResponseTypeWheel  BuildTargetOutputGetResponseType = "wheel"
)

type BuildTargetOutputGetResponseURL added in v0.25.0 

type BuildTargetOutputGetResponseURL struct {
	Output constant.URL `json:"output,required"`
	// Any of "node", "typescript", "python", "go", "java", "kotlin", "ruby",
	// "terraform", "cli", "php", "csharp".
	Target shared.Target `json:"target,required"`
	// Any of "source", "dist", "wheel".
	Type BuildTargetOutputGetResponseURLType `json:"type,required"`
	// URL for direct download
	URL string `json:"url,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Output      respjson.Field
		Target      respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetOutputGetResponseURL) RawJSON added in v0.25.0 

func (r BuildTargetOutputGetResponseURL) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetOutputGetResponseURL) UnmarshalJSON added in v0.25.0 

func (r *BuildTargetOutputGetResponseURL) UnmarshalJSON(data []byte) error

type BuildTargetOutputGetResponseURLType added in v0.25.0 

type BuildTargetOutputGetResponseURLType string
const (
	BuildTargetOutputGetResponseURLTypeSource BuildTargetOutputGetResponseURLType = "source"
	BuildTargetOutputGetResponseURLTypeDist   BuildTargetOutputGetResponseURLType = "dist"
	BuildTargetOutputGetResponseURLTypeWheel  BuildTargetOutputGetResponseURLType = "wheel"
)

type BuildTargetOutputGetResponseUnion added in v0.2.0 

type BuildTargetOutputGetResponseUnion struct {
	// Any of "url", "git".
	Output string `json:"output"`
	// This field is from variant [BuildTargetOutputGetResponseURL].
	Target shared.Target `json:"target"`
	Type   string        `json:"type"`
	URL    string        `json:"url"`
	// This field is from variant [BuildTargetOutputGetResponseGit].
	Token string `json:"token"`
	// This field is from variant [BuildTargetOutputGetResponseGit].
	Ref  string `json:"ref"`
	JSON struct {
		Output respjson.Field
		Target respjson.Field
		Type   respjson.Field
		URL    respjson.Field
		Token  respjson.Field
		Ref    respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

BuildTargetOutputGetResponseUnion contains all possible properties and values from BuildTargetOutputGetResponseURL, BuildTargetOutputGetResponseGit.

Use the BuildTargetOutputGetResponseUnion.AsAny method to switch on the variant.

Use the methods beginning with 'As' to cast the union to one of its variants.

func (BuildTargetOutputGetResponseUnion) AsAny added in v0.25.0 

func (u BuildTargetOutputGetResponseUnion) AsAny() anyBuildTargetOutputGetResponse

Use the following switch statement to find the correct variant 

switch variant := BuildTargetOutputGetResponseUnion.AsAny().(type) {
case stainless.BuildTargetOutputGetResponseURL:
case stainless.BuildTargetOutputGetResponseGit:
default:
  fmt.Errorf("no variant present")
}

func (BuildTargetOutputGetResponseUnion) AsGit added in v0.25.0 

func (u BuildTargetOutputGetResponseUnion) AsGit() (v BuildTargetOutputGetResponseGit)

func (BuildTargetOutputGetResponseUnion) AsURL added in v0.25.0 

func (u BuildTargetOutputGetResponseUnion) AsURL() (v BuildTargetOutputGetResponseURL)

func (BuildTargetOutputGetResponseUnion) RawJSON added in v0.2.0 

func (u BuildTargetOutputGetResponseUnion) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetOutputGetResponseUnion) UnmarshalJSON added in v0.2.0 

func (r *BuildTargetOutputGetResponseUnion) UnmarshalJSON(data []byte) error

type BuildTargetOutputService added in v0.1.1 

type BuildTargetOutputService struct {
	Options []option.RequestOption
}

BuildTargetOutputService contains methods and other services that help with interacting with the stainless API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBuildTargetOutputService method instead.

func NewBuildTargetOutputService added in v0.1.1 

func NewBuildTargetOutputService(opts ...option.RequestOption) (r BuildTargetOutputService)

NewBuildTargetOutputService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BuildTargetOutputService) Get added in v0.2.0 

func (r *BuildTargetOutputService) Get(ctx context.Context, query BuildTargetOutputGetParams, opts ...option.RequestOption) (res *BuildTargetOutputGetResponseUnion, err error)

Retrieve a method to download an output for a given build target.

If the requested type of output is `source`, and the requested output method is `url`, a download link to a tarball of the source files is returned. If the requested output method is `git`, a Git remote, ref, and access token (if necessary) is returned.

Otherwise, the possible types of outputs are specific to the requested target, and the output method _must_ be `url`. See the documentation for `type` for more information.

type BuildTargetStatus 

type BuildTargetStatus string
const (
	BuildTargetStatusNotStarted BuildTargetStatus = "not_started"
	BuildTargetStatusCodegen    BuildTargetStatus = "codegen"
	BuildTargetStatusPostgen    BuildTargetStatus = "postgen"
	BuildTargetStatusCompleted  BuildTargetStatus = "completed"
)

type BuildTargets 

type BuildTargets struct {
	Cli        BuildTarget `json:"cli"`
	Csharp     BuildTarget `json:"csharp"`
	Go         BuildTarget `json:"go"`
	Java       BuildTarget `json:"java"`
	Kotlin     BuildTarget `json:"kotlin"`
	Node       BuildTarget `json:"node"`
	Php        BuildTarget `json:"php"`
	Python     BuildTarget `json:"python"`
	Ruby       BuildTarget `json:"ruby"`
	Terraform  BuildTarget `json:"terraform"`
	Typescript BuildTarget `json:"typescript"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Cli         respjson.Field
		Csharp      respjson.Field
		Go          respjson.Field
		Java        respjson.Field
		Kotlin      respjson.Field
		Node        respjson.Field
		Php         respjson.Field
		Python      respjson.Field
		Ruby        respjson.Field
		Terraform   respjson.Field
		Typescript  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargets) RawJSON added in v0.25.0 

func (r BuildTargets) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargets) UnmarshalJSON 

func (r *BuildTargets) UnmarshalJSON(data []byte) error

type CheckStepCompleted added in v0.24.0 

type CheckStepCompleted struct {
	Completed CheckStepCompletedCompleted `json:"completed,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
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CheckStepCompleted) RawJSON added in v0.24.0 

func (r CheckStepCompleted) RawJSON() string

Returns the unmodified JSON received from the API

func (*CheckStepCompleted) UnmarshalJSON added in v0.24.0 

func (r *CheckStepCompleted) UnmarshalJSON(data []byte) error

type CheckStepCompletedCompleted added in v0.24.0 

type CheckStepCompletedCompleted struct {
	// Any of "success", "failure", "skipped", "cancelled", "action_required",
	// "neutral", "timed_out".
	Conclusion string `json:"conclusion,required"`
	URL        string `json:"url,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Conclusion  respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CheckStepCompletedCompleted) RawJSON added in v0.24.0 

func (r CheckStepCompletedCompleted) RawJSON() string

Returns the unmodified JSON received from the API

func (*CheckStepCompletedCompleted) UnmarshalJSON added in v0.24.0 

func (r *CheckStepCompletedCompleted) UnmarshalJSON(data []byte) error

type CheckStepInProgress added in v0.24.0 

type CheckStepInProgress struct {
	Status constant.InProgress `json:"status,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CheckStepInProgress) RawJSON added in v0.24.0 

func (r CheckStepInProgress) RawJSON() string

Returns the unmodified JSON received from the API

func (*CheckStepInProgress) UnmarshalJSON added in v0.24.0 

func (r *CheckStepInProgress) UnmarshalJSON(data []byte) error

type CheckStepNotStarted added in v0.24.0 

type CheckStepNotStarted struct {
	Status constant.NotStarted `json:"status,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CheckStepNotStarted) RawJSON added in v0.24.0 

func (r CheckStepNotStarted) RawJSON() string

Returns the unmodified JSON received from the API

func (*CheckStepNotStarted) UnmarshalJSON added in v0.24.0 

func (r *CheckStepNotStarted) UnmarshalJSON(data []byte) error

type CheckStepQueued added in v0.24.0 

type CheckStepQueued struct {
	Status constant.Queued `json:"status,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CheckStepQueued) RawJSON added in v0.24.0 

func (r CheckStepQueued) RawJSON() string

Returns the unmodified JSON received from the API

func (*CheckStepQueued) UnmarshalJSON added in v0.24.0 

func (r *CheckStepQueued) UnmarshalJSON(data []byte) error

type CheckStepUnion added in v0.18.0 

type CheckStepUnion struct {
	// Any of "not_started", "queued", "in_progress", "completed".
	Status string `json:"status"`
	// This field is from variant [CheckStepCompleted].
	Completed CheckStepCompletedCompleted `json:"completed"`
	JSON      struct {
		Status    respjson.Field
		Completed respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

CheckStepUnion contains all possible properties and values from CheckStepNotStarted, CheckStepQueued, CheckStepInProgress, CheckStepCompleted.

Use the CheckStepUnion.AsAny method to switch on the variant.

Use the methods beginning with 'As' to cast the union to one of its variants.

func (CheckStepUnion) AsAny added in v0.24.0 

func (u CheckStepUnion) AsAny() anyCheckStep

Use the following switch statement to find the correct variant 

switch variant := CheckStepUnion.AsAny().(type) {
case stainless.CheckStepNotStarted:
case stainless.CheckStepQueued:
case stainless.CheckStepInProgress:
case stainless.CheckStepCompleted:
default:
  fmt.Errorf("no variant present")
}

func (CheckStepUnion) AsCompleted added in v0.24.0 

func (u CheckStepUnion) AsCompleted() (v CheckStepCompleted)

func (CheckStepUnion) AsInProgress added in v0.24.0 

func (u CheckStepUnion) AsInProgress() (v CheckStepInProgress)

func (CheckStepUnion) AsNotStarted added in v0.24.0 

func (u CheckStepUnion) AsNotStarted() (v CheckStepNotStarted)

func (CheckStepUnion) AsQueued added in v0.24.0 

func (u CheckStepUnion) AsQueued() (v CheckStepQueued)

func (CheckStepUnion) RawJSON added in v0.18.0 

func (u CheckStepUnion) RawJSON() string

Returns the unmodified JSON received from the API

func (*CheckStepUnion) UnmarshalJSON added in v0.18.0 

func (r *CheckStepUnion) UnmarshalJSON(data []byte) error

type Client 

type Client struct {
	Options  []option.RequestOption
	Projects ProjectService
	Builds   BuildService
	Orgs     OrgService
}

Client creates a struct with services and top level methods that help with interacting with the stainless API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r Client)

NewClient generates a new client with the default option read from the environment (STAINLESS_API_KEY, STAINLESS_BASE_URL). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned url.Values will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type Commit 

type Commit = shared.Commit

This is an alias to an internal type.

type CommitRepo added in v0.18.0 

type CommitRepo = shared.CommitRepo

This is an alias to an internal type.

type Error 

type Error = apierror.Error

type FileInputContentParam added in v0.15.0 

type FileInputContentParam = shared.FileInputContentParam

This is an alias to an internal type.

type FileInputURLParam added in v0.15.0 

type FileInputURLParam = shared.FileInputURLParam

This is an alias to an internal type.

type FileInputUnionParam added in v0.15.0 

type FileInputUnionParam = shared.FileInputUnionParam

This is an alias to an internal type.

type Org added in v0.17.0 

type Org struct {
	DisplayName string `json:"display_name,required"`
	// Any of "org".
	Object OrgObject `json:"object,required"`
	Slug   string    `json:"slug,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		DisplayName respjson.Field
		Object      respjson.Field
		Slug        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (Org) RawJSON added in v0.17.0 

func (r Org) RawJSON() string

Returns the unmodified JSON received from the API

func (*Org) UnmarshalJSON added in v0.17.0 

func (r *Org) UnmarshalJSON(data []byte) error

type OrgListResponse added in v0.3.0 

type OrgListResponse struct {
	Data       []Org  `json:"data,required"`
	HasMore    bool   `json:"has_more,required"`
	NextCursor string `json:"next_cursor"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		HasMore     respjson.Field
		NextCursor  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (OrgListResponse) RawJSON added in v0.3.0 

func (r OrgListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*OrgListResponse) UnmarshalJSON added in v0.3.0 

func (r *OrgListResponse) UnmarshalJSON(data []byte) error

type OrgObject added in v0.17.0 

type OrgObject string
const (
	OrgObjectOrg OrgObject = "org"
)

type OrgService added in v0.3.0 

type OrgService struct {
	Options []option.RequestOption
}

OrgService contains methods and other services that help with interacting with the stainless API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgService method instead.

func NewOrgService added in v0.3.0 

func NewOrgService(opts ...option.RequestOption) (r OrgService)

NewOrgService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgService) Get added in v0.3.0 

func (r *OrgService) Get(ctx context.Context, org string, opts ...option.RequestOption) (res *Org, err error)

Retrieve an organization by name.

func (*OrgService) List added in v0.3.0 

func (r *OrgService) List(ctx context.Context, opts ...option.RequestOption) (res *OrgListResponse, err error)

List organizations accessible to the current authentication method.

type Project added in v0.17.0 

type Project struct {
	ConfigRepo  string `json:"config_repo,required"`
	DisplayName string `json:"display_name,required"`
	// Any of "project".
	Object  ProjectObject   `json:"object,required"`
	Org     string          `json:"org,required"`
	Slug    string          `json:"slug,required"`
	Targets []shared.Target `json:"targets,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ConfigRepo  respjson.Field
		DisplayName respjson.Field
		Object      respjson.Field
		Org         respjson.Field
		Slug        respjson.Field
		Targets     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

A project is a collection of SDKs generated from the same set of config files.

func (Project) RawJSON added in v0.17.0 

func (r Project) RawJSON() string

Returns the unmodified JSON received from the API

func (*Project) UnmarshalJSON added in v0.17.0 

func (r *Project) UnmarshalJSON(data []byte) error

type ProjectBranch added in v0.1.1 

type ProjectBranch struct {
	// Branch name
	Branch string `json:"branch,required"`
	// A Git commit that points to the latest set of config files on a given branch.
	ConfigCommit ProjectBranchConfigCommit `json:"config_commit,required"`
	LatestBuild  Build                     `json:"latest_build,required"`
	// Any of "project_branch".
	Object ProjectBranchObject `json:"object,required"`
	Org    string              `json:"org,required"`
	// Project name
	Project string `json:"project,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Branch       respjson.Field
		ConfigCommit respjson.Field
		LatestBuild  respjson.Field
		Object       respjson.Field
		Org          respjson.Field
		Project      respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

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.

func (ProjectBranch) RawJSON added in v0.1.1 

func (r ProjectBranch) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectBranch) UnmarshalJSON added in v0.1.1 

func (r *ProjectBranch) UnmarshalJSON(data []byte) error

type ProjectBranchConfigCommit added in v0.1.1 

type ProjectBranchConfigCommit struct {
	Repo ProjectBranchConfigCommitRepo `json:"repo,required"`
	Sha  string                        `json:"sha,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Repo        respjson.Field
		Sha         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

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

func (ProjectBranchConfigCommit) RawJSON added in v0.1.1 

func (r ProjectBranchConfigCommit) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectBranchConfigCommit) UnmarshalJSON added in v0.1.1 

func (r *ProjectBranchConfigCommit) UnmarshalJSON(data []byte) error

type ProjectBranchConfigCommitRepo added in v0.1.1 

type ProjectBranchConfigCommitRepo struct {
	Branch string `json:"branch,required"`
	Name   string `json:"name,required"`
	Owner  string `json:"owner,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Branch      respjson.Field
		Name        respjson.Field
		Owner       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (ProjectBranchConfigCommitRepo) RawJSON added in v0.1.1 

func (r ProjectBranchConfigCommitRepo) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectBranchConfigCommitRepo) UnmarshalJSON added in v0.1.1 

func (r *ProjectBranchConfigCommitRepo) UnmarshalJSON(data []byte) error

type ProjectBranchDeleteParams added in v0.21.0 

type ProjectBranchDeleteParams struct {
	// Use [option.WithProject] on the client to set a global default for this field.
	Project param.Opt[string] `path:"project,omitzero,required" json:"-"`
	// contains filtered or unexported fields
}

type ProjectBranchDeleteResponse added in v0.21.0 

type ProjectBranchDeleteResponse = any

type ProjectBranchGetParams added in v0.4.0 

type ProjectBranchGetParams struct {
	// Use [option.WithProject] on the client to set a global default for this field.
	Project param.Opt[string] `path:"project,omitzero,required" json:"-"`
	// contains filtered or unexported fields
}

type ProjectBranchListParams added in v0.21.0 

type ProjectBranchListParams struct {
	// Use [option.WithProject] on the client to set a global default for this field.
	Project param.Opt[string] `path:"project,omitzero,required" json:"-"`
	// Pagination cursor from a previous response
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of items to return, defaults to 10 (maximum: 100).
	Limit param.Opt[float64] `query:"limit,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (ProjectBranchListParams) URLQuery added in v0.21.0 

func (r ProjectBranchListParams) URLQuery() (v url.Values, err error)

URLQuery serializes ProjectBranchListParams's query parameters as `url.Values`.

type ProjectBranchListResponse added in v0.21.0 

type ProjectBranchListResponse struct {
	// Branch name
	Branch string `json:"branch,required"`
	// A Git commit that points to the latest set of config files on a given branch.
	ConfigCommit  ProjectBranchListResponseConfigCommit `json:"config_commit,required"`
	LatestBuildID string                                `json:"latest_build_id,required"`
	// Any of "project_branch".
	Object ProjectBranchListResponseObject `json:"object,required"`
	Org    string                          `json:"org,required"`
	// Project name
	Project string `json:"project,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Branch        respjson.Field
		ConfigCommit  respjson.Field
		LatestBuildID respjson.Field
		Object        respjson.Field
		Org           respjson.Field
		Project       respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

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.

func (ProjectBranchListResponse) RawJSON added in v0.21.0 

func (r ProjectBranchListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectBranchListResponse) UnmarshalJSON added in v0.21.0 

func (r *ProjectBranchListResponse) UnmarshalJSON(data []byte) error

type ProjectBranchListResponseConfigCommit added in v0.21.0 

type ProjectBranchListResponseConfigCommit struct {
	Repo ProjectBranchListResponseConfigCommitRepo `json:"repo,required"`
	Sha  string                                    `json:"sha,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Repo        respjson.Field
		Sha         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

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

func (ProjectBranchListResponseConfigCommit) RawJSON added in v0.21.0 

func (r ProjectBranchListResponseConfigCommit) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectBranchListResponseConfigCommit) UnmarshalJSON added in v0.21.0 

func (r *ProjectBranchListResponseConfigCommit) UnmarshalJSON(data []byte) error

type ProjectBranchListResponseConfigCommitRepo added in v0.21.0 

type ProjectBranchListResponseConfigCommitRepo struct {
	Branch string `json:"branch,required"`
	Name   string `json:"name,required"`
	Owner  string `json:"owner,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Branch      respjson.Field
		Name        respjson.Field
		Owner       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (ProjectBranchListResponseConfigCommitRepo) RawJSON added in v0.21.0 

func (r ProjectBranchListResponseConfigCommitRepo) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectBranchListResponseConfigCommitRepo) UnmarshalJSON added in v0.21.0 

func (r *ProjectBranchListResponseConfigCommitRepo) UnmarshalJSON(data []byte) error

type ProjectBranchListResponseObject added in v0.21.0 

type ProjectBranchListResponseObject string
const (
	ProjectBranchListResponseObjectProjectBranch ProjectBranchListResponseObject = "project_branch"
)

type ProjectBranchNewParams added in v0.1.1 

type ProjectBranchNewParams struct {
	// Use [option.WithProject] on the client to set a global default for this field.
	Project param.Opt[string] `path:"project,omitzero,required" json:"-"`
	// Branch name
	Branch string `json:"branch,required"`
	// Branch or commit SHA to branch from
	BranchFrom string `json:"branch_from,required"`
	// Whether to throw an error if the branch already exists. Defaults to false.
	Force param.Opt[bool] `json:"force,omitzero"`
	// contains filtered or unexported fields
}

func (ProjectBranchNewParams) MarshalJSON added in v0.1.1 

func (r ProjectBranchNewParams) MarshalJSON() (data []byte, err error)

func (*ProjectBranchNewParams) UnmarshalJSON added in v0.4.0 

func (r *ProjectBranchNewParams) UnmarshalJSON(data []byte) error

type ProjectBranchObject added in v0.1.1 

type ProjectBranchObject string
const (
	ProjectBranchObjectProjectBranch ProjectBranchObject = "project_branch"
)

type ProjectBranchRebaseParams added in v0.24.0 

type ProjectBranchRebaseParams struct {
	// Use [option.WithProject] on the client to set a global default for this field.
	Project param.Opt[string] `path:"project,omitzero,required" json:"-"`
	// The branch or commit SHA to rebase onto. Defaults to "main".
	Base param.Opt[string] `query:"base,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (ProjectBranchRebaseParams) URLQuery added in v0.24.0 

func (r ProjectBranchRebaseParams) URLQuery() (v url.Values, err error)

URLQuery serializes ProjectBranchRebaseParams's query parameters as `url.Values`.

type ProjectBranchService added in v0.1.1 

type ProjectBranchService struct {
	Options []option.RequestOption
}

ProjectBranchService contains methods and other services that help with interacting with the stainless API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProjectBranchService method instead.

func NewProjectBranchService added in v0.1.1 

func NewProjectBranchService(opts ...option.RequestOption) (r ProjectBranchService)

NewProjectBranchService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ProjectBranchService) Delete added in v0.21.0 

func (r *ProjectBranchService) Delete(ctx context.Context, branch string, body ProjectBranchDeleteParams, opts ...option.RequestOption) (res *ProjectBranchDeleteResponse, err error)

Delete a project branch by name.

func (*ProjectBranchService) Get added in v0.1.1 

func (r *ProjectBranchService) Get(ctx context.Context, branch string, query ProjectBranchGetParams, opts ...option.RequestOption) (res *ProjectBranch, err error)

Retrieve a project branch by name.

func (*ProjectBranchService) List added in v0.21.0 

func (r *ProjectBranchService) List(ctx context.Context, params ProjectBranchListParams, opts ...option.RequestOption) (res *pagination.Page[ProjectBranchListResponse], err error)

Retrieve a project branch by name.

func (*ProjectBranchService) ListAutoPaging added in v0.21.0 

func (r *ProjectBranchService) ListAutoPaging(ctx context.Context, params ProjectBranchListParams, opts ...option.RequestOption) *pagination.PageAutoPager[ProjectBranchListResponse]

Retrieve a project branch by name.

func (*ProjectBranchService) New added in v0.1.1 

func (r *ProjectBranchService) New(ctx context.Context, params ProjectBranchNewParams, opts ...option.RequestOption) (res *ProjectBranch, err error)

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.

func (*ProjectBranchService) Rebase added in v0.24.0 

func (r *ProjectBranchService) Rebase(ctx context.Context, branch string, params ProjectBranchRebaseParams, opts ...option.RequestOption) (res *ProjectBranch, err error)

Rebase a project branch.

The branch is rebased onto the `base` branch or commit SHA, inheriting any config and custom code changes.

type ProjectConfigGetParams added in v0.2.0 

type ProjectConfigGetParams struct {
	// Use [option.WithProject] on the client to set a global default for this field.
	Project param.Opt[string] `path:"project,omitzero,required" json:"-"`
	// Branch name, defaults to "main".
	Branch  param.Opt[string] `query:"branch,omitzero" json:"-"`
	Include param.Opt[string] `query:"include,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (ProjectConfigGetParams) URLQuery added in v0.2.0 

func (r ProjectConfigGetParams) URLQuery() (v url.Values, err error)

URLQuery serializes ProjectConfigGetParams's query parameters as `url.Values`.

type ProjectConfigGetResponse added in v0.2.0 

type ProjectConfigGetResponse map[string]ProjectConfigGetResponseItem

type ProjectConfigGetResponseItem added in v0.2.0 

type ProjectConfigGetResponseItem struct {
	// The file content
	Content string `json:"content,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Content     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (ProjectConfigGetResponseItem) RawJSON added in v0.2.0 

func (r ProjectConfigGetResponseItem) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectConfigGetResponseItem) UnmarshalJSON added in v0.2.0 

func (r *ProjectConfigGetResponseItem) UnmarshalJSON(data []byte) error

type ProjectConfigGuessParams added in v0.2.0 

type ProjectConfigGuessParams struct {
	// Use [option.WithProject] on the client to set a global default for this field.
	Project param.Opt[string] `path:"project,omitzero,required" json:"-"`
	// OpenAPI spec
	Spec string `json:"spec,required"`
	// Branch name
	Branch param.Opt[string] `json:"branch,omitzero"`
	// contains filtered or unexported fields
}

func (ProjectConfigGuessParams) MarshalJSON added in v0.2.0 

func (r ProjectConfigGuessParams) MarshalJSON() (data []byte, err error)

func (*ProjectConfigGuessParams) UnmarshalJSON added in v0.4.0 

func (r *ProjectConfigGuessParams) UnmarshalJSON(data []byte) error

type ProjectConfigGuessResponse added in v0.2.0 

type ProjectConfigGuessResponse map[string]ProjectConfigGuessResponseItem

type ProjectConfigGuessResponseItem added in v0.2.0 

type ProjectConfigGuessResponseItem struct {
	// The file content
	Content string `json:"content,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Content     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (ProjectConfigGuessResponseItem) RawJSON added in v0.2.0 

func (r ProjectConfigGuessResponseItem) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectConfigGuessResponseItem) UnmarshalJSON added in v0.2.0 

func (r *ProjectConfigGuessResponseItem) UnmarshalJSON(data []byte) error

type ProjectConfigService 

type ProjectConfigService struct {
	Options []option.RequestOption
}

ProjectConfigService contains methods and other services that help with interacting with the stainless API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProjectConfigService method instead.

func NewProjectConfigService 

func NewProjectConfigService(opts ...option.RequestOption) (r ProjectConfigService)

NewProjectConfigService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ProjectConfigService) Get added in v0.2.0 

func (r *ProjectConfigService) Get(ctx context.Context, params ProjectConfigGetParams, opts ...option.RequestOption) (res *ProjectConfigGetResponse, err error)

Retrieve the configuration files for a given project.

func (*ProjectConfigService) Guess added in v0.2.0 

func (r *ProjectConfigService) Guess(ctx context.Context, params ProjectConfigGuessParams, opts ...option.RequestOption) (res *ProjectConfigGuessResponse, err error)

Generate suggestions for changes to config files based on an OpenAPI spec.

type ProjectGetParams added in v0.5.0 

type ProjectGetParams struct {
	// Use [option.WithProject] on the client to set a global default for this field.
	Project param.Opt[string] `path:"project,omitzero,required" json:"-"`
	// contains filtered or unexported fields
}

type ProjectListParams added in v0.3.0 

type ProjectListParams struct {
	// Pagination cursor from a previous response
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of projects to return, defaults to 10 (maximum: 100).
	Limit param.Opt[float64] `query:"limit,omitzero" json:"-"`
	Org   param.Opt[string]  `query:"org,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (ProjectListParams) URLQuery added in v0.3.0 

func (r ProjectListParams) URLQuery() (v url.Values, err error)

URLQuery serializes ProjectListParams's query parameters as `url.Values`.

type ProjectNewParams added in v0.7.0 

type ProjectNewParams struct {
	// Human-readable project name
	DisplayName string `json:"display_name,required"`
	// Organization name
	Org string `json:"org,required"`
	// File contents to commit
	Revision map[string]shared.FileInputUnionParam `json:"revision,omitzero,required"`
	// Project name/slug
	Slug string `json:"slug,required"`
	// Targets to generate for
	Targets []shared.Target `json:"targets,omitzero,required"`
	// contains filtered or unexported fields
}

func (ProjectNewParams) MarshalJSON added in v0.7.0 

func (r ProjectNewParams) MarshalJSON() (data []byte, err error)

func (*ProjectNewParams) UnmarshalJSON added in v0.7.0 

func (r *ProjectNewParams) UnmarshalJSON(data []byte) error

type ProjectObject added in v0.17.0 

type ProjectObject string
const (
	ProjectObjectProject ProjectObject = "project"
)

type ProjectService 

type ProjectService struct {
	Options  []option.RequestOption
	Branches ProjectBranchService
	Configs  ProjectConfigService
}

ProjectService contains methods and other services that help with interacting with the stainless API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProjectService method instead.

func NewProjectService 

func NewProjectService(opts ...option.RequestOption) (r ProjectService)

NewProjectService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ProjectService) Get added in v0.1.1 

func (r *ProjectService) Get(ctx context.Context, query ProjectGetParams, opts ...option.RequestOption) (res *Project, err error)

Retrieve a project by name.

func (*ProjectService) List added in v0.3.0 

func (r *ProjectService) List(ctx context.Context, query ProjectListParams, opts ...option.RequestOption) (res *pagination.Page[Project], err error)

List projects in an organization, from oldest to newest.

func (*ProjectService) ListAutoPaging added in v0.13.0 

func (r *ProjectService) ListAutoPaging(ctx context.Context, query ProjectListParams, opts ...option.RequestOption) *pagination.PageAutoPager[Project]

List projects in an organization, from oldest to newest.

func (*ProjectService) New added in v0.7.0 

func (r *ProjectService) New(ctx context.Context, body ProjectNewParams, opts ...option.RequestOption) (res *Project, err error)

Create a new project.

func (*ProjectService) Update added in v0.1.1 

func (r *ProjectService) Update(ctx context.Context, params ProjectUpdateParams, opts ...option.RequestOption) (res *Project, err error)

Update a project's properties.

type ProjectUpdateParams added in v0.1.1 

type ProjectUpdateParams struct {
	// Use [option.WithProject] on the client to set a global default for this field.
	Project     param.Opt[string] `path:"project,omitzero,required" json:"-"`
	DisplayName param.Opt[string] `json:"display_name,omitzero"`
	// contains filtered or unexported fields
}

func (ProjectUpdateParams) MarshalJSON added in v0.1.1 

func (r ProjectUpdateParams) MarshalJSON() (data []byte, err error)

func (*ProjectUpdateParams) UnmarshalJSON added in v0.4.0 

func (r *ProjectUpdateParams) UnmarshalJSON(data []byte) error

type Target added in v0.17.0 

type Target = shared.Target

This is an alias to an internal type.

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
encoding/json
Package json implements encoding and decoding of JSON as defined in RFC 7159.
 Package json implements encoding and decoding of JSON as defined in RFC 7159.
encoding/json/sentinel
encoding/json/shims
This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
 This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
paramutil
requestconfig
testutil
packages
pagination
param
respjson
constant

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.