stainlessv0

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: Apr 28, 2025 License: Apache-2.0 Imports: 17 Imported by: 7

README

Stainless V0 Go API Library

Go Reference

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

It is generated with Stainless.

Installation

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

Or to pin the version:

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

Requirements

This library requires Go 1.18+.

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 := stainlessv0.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("STAINLESS_V0_API_KEY")
	)
	buildObject, err := client.Builds.New(context.TODO(), stainlessv0.BuildNewParams{
		Project: "project",
		Revision: stainlessv0.BuildNewParamsRevisionUnion{
			OfString: stainlessv0.String("string"),
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", buildObject.ID)
}
Request fields

The stainlessv0 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, stainlessv0.String(string), stainlessv0.Int(int64), etc.

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

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

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

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

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

params.Description = param.NullOpt[string]() // explicit null string property
params.Point = param.NullObj[Point]()        // explicit null struct property

Request structs contain a .WithExtraFields(map[string]any) method which can send non-conforming fields in the request body. Extra fields overwrite any struct fields with a matching key. For security reasons, only use WithExtraFields with trusted data.

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

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

// Send a number instead of an object
custom := param.OverrideObj[stainlessv0.FooParams](12)

When available, use the .IsPresent() method to check if an optional parameter is not omitted or null. The param.IsOmitted(any) function can confirm the presence of any omitzero field.

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        resp.Field
		Owner       resp.Field
		Age         resp.Field
		ExtraFields map[string]resp.Field
	} `json:"-"`
}

To handle optional data, use the IsPresent() method on the JSON field. If a field is null, not present, or invalid, the corresponding field will simply be its zero value.

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

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

// Use the IsPresent() method to handle optional fields
res.Owners                  // 1
res.JSON.Owners.IsPresent() // true
res.JSON.Owners.Raw()       // "1"

res.Age                  // 0
res.JSON.Age.IsPresent() // false
res.JSON.Age.Raw()       // ""

// Use the IsExplicitNull() method to differentiate null and omitted
res.Name                       // ""
res.JSON.Name.IsPresent()      // false
res.JSON.Name.Raw()            // "null"
res.JSON.Name.IsExplicitNull() // 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 resp.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 := stainlessv0.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"}),
)

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:

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.:

Errors

When the API returns a non-success status code, we return an error with type *stainlessv0.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(), stainlessv0.BuildNewParams{
	Project: "project",
	Revision: stainlessv0.BuildNewParamsRevisionUnion{
		OfString: stainlessv0.String("string"),
	},
})
if err != nil {
	var apierr *stainlessv0.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/v0/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,
	stainlessv0.BuildNewParams{
		Project: "project",
		Revision: stainlessv0.BuildNewParamsRevisionUnion{
			OfString: stainlessv0.String("string"),
		},
	},
	// 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 stainlessv0.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 := stainlessv0.NewClient(
	option.WithMaxRetries(0), // default is 2
)

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

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
buildObject, err := client.Builds.New(
	context.TODO(),
	stainlessv0.BuildNewParams{
		Project: "project",
		Revision: stainlessv0.BuildNewParamsRevisionUnion{
			OfString: stainlessv0.String("string"),
		},
	},
	option.WithResponseInto(&response),
)
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", buildObject)

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: stainlessv0.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 := stainlessv0.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

This section is empty.

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_V0_API_KEY, STAINLESS_V0_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 BuildListParams added in v0.1.1 

type BuildListParams struct {
	// Project name
	Project string `query:"project,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
	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) IsPresent added in v0.1.1 

func (f BuildListParams) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

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) IsPresent added in v0.2.0 

func (f BuildListParamsRevisionMapItem) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

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"`
	OfBuildListsRevisionMap 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.

func (BuildListParamsRevisionUnion) IsPresent added in v0.2.0 

func (u BuildListParamsRevisionUnion) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

type BuildListResponse added in v0.1.1 

type BuildListResponse struct {
	Data       []BuildObject `json:"data,required"`
	HasMore    bool          `json:"has_more,required"`
	NextCursor string        `json:"next_cursor"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Data        resp.Field
		HasMore     resp.Field
		NextCursor  resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildListResponse) RawJSON added in v0.1.1 

func (r BuildListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildListResponse) UnmarshalJSON added in v0.1.1 

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

type BuildNewParams 

type BuildNewParams struct {
	// Project name
	Project string `json:"project,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"`
	// Optional branch to use. If not specified, defaults to "main". When using a
	// branch name or merge command as revision, this must match or be omitted.
	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.
	//
	// Any of "node", "typescript", "python", "go", "java", "kotlin", "ruby",
	// "terraform", "cli".
	Targets []string `json:"targets,omitzero"`
	// contains filtered or unexported fields
}

func (BuildNewParams) IsPresent added in v0.1.1 

func (f BuildNewParams) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

func (BuildNewParams) MarshalJSON 

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

type BuildNewParamsRevisionMapItem added in v0.1.1 

type BuildNewParamsRevisionMapItem struct {
	// The file content
	Content string `json:"content,required"`
	// contains filtered or unexported fields
}

The property Content is required.

func (BuildNewParamsRevisionMapItem) IsPresent added in v0.1.1 

func (f BuildNewParamsRevisionMapItem) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

func (BuildNewParamsRevisionMapItem) MarshalJSON added in v0.1.1 

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

type BuildNewParamsRevisionUnion added in v0.1.1 

type BuildNewParamsRevisionUnion struct {
	OfString               param.Opt[string]                        `json:",omitzero,inline"`
	OfBuildNewsRevisionMap map[string]BuildNewParamsRevisionMapItem `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) IsPresent added in v0.1.1 

func (u BuildNewParamsRevisionUnion) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

func (BuildNewParamsRevisionUnion) MarshalJSON added in v0.1.1 

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

type BuildObject 

type BuildObject struct {
	ID           string `json:"id,required"`
	ConfigCommit string `json:"config_commit,required"`
	// Any of "build".
	Object  BuildObjectObject  `json:"object,required"`
	Targets BuildObjectTargets `json:"targets,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		ID           resp.Field
		ConfigCommit resp.Field
		Object       resp.Field
		Targets      resp.Field
		ExtraFields  map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildObject) RawJSON added in v0.1.1 

func (r BuildObject) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildObject) UnmarshalJSON added in v0.1.1 

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

type BuildObjectObject added in v0.1.1 

type BuildObjectObject string
const (
	BuildObjectObjectBuild BuildObjectObject = "build"
)

type BuildObjectTargets added in v0.1.1 

type BuildObjectTargets struct {
	Cli        BuildTarget `json:"cli"`
	Go         BuildTarget `json:"go"`
	Java       BuildTarget `json:"java"`
	Kotlin     BuildTarget `json:"kotlin"`
	Node       BuildTarget `json:"node"`
	Python     BuildTarget `json:"python"`
	Ruby       BuildTarget `json:"ruby"`
	Terraform  BuildTarget `json:"terraform"`
	Typescript BuildTarget `json:"typescript"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Cli         resp.Field
		Go          resp.Field
		Java        resp.Field
		Kotlin      resp.Field
		Node        resp.Field
		Python      resp.Field
		Ruby        resp.Field
		Terraform   resp.Field
		Typescript  resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildObjectTargets) RawJSON added in v0.1.1 

func (r BuildObjectTargets) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildObjectTargets) UnmarshalJSON added in v0.1.1 

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

type BuildService 

type BuildService struct {
	Options []option.RequestOption
}

BuildService contains methods and other services that help with interacting with the stainless-v0 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) Get 

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

TODO

func (*BuildService) List added in v0.1.1 

func (r *BuildService) List(ctx context.Context, query BuildListParams, opts ...option.RequestOption) (res *BuildListResponse, err error)

TODO

func (*BuildService) New 

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

TODO

type BuildTarget 

type BuildTarget struct {
	Commit BuildTargetCommitUnion `json:"commit,required"`
	Lint   BuildTargetLintUnion   `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   BuildTargetTestUnion `json:"test,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Commit      resp.Field
		Lint        resp.Field
		Object      resp.Field
		Status      resp.Field
		Test        resp.Field
		ExtraFields map[string]resp.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"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Completed   resp.Field
		Status      resp.Field
		ExtraFields map[string]resp.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 BuildTargetCommitCompletedCompletedCommit `json:"commit,required"`
	// Any of "success", "failure", "skipped", "cancelled", "action_required",
	// "neutral", "timed_out", "error", "warning", "note", "merge_conflict",
	// "upstream_merge_conflict", "fatal", "payment_required", "noop", "version_bump".
	Conclusion      string                                             `json:"conclusion,required"`
	MergeConflictPr BuildTargetCommitCompletedCompletedMergeConflictPr `json:"merge_conflict_pr,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Commit          resp.Field
		Conclusion      resp.Field
		MergeConflictPr resp.Field
		ExtraFields     map[string]resp.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 BuildTargetCommitCompletedCompletedCommit added in v0.1.1 

type BuildTargetCommitCompletedCompletedCommit struct {
	Repo BuildTargetCommitCompletedCompletedCommitRepo `json:"repo,required"`
	Sha  string                                        `json:"sha,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Repo        resp.Field
		Sha         resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetCommitCompletedCompletedCommit) RawJSON added in v0.1.1 

func (r BuildTargetCommitCompletedCompletedCommit) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitCompletedCompletedCommit) UnmarshalJSON added in v0.1.1 

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

type BuildTargetCommitCompletedCompletedCommitRepo added in v0.1.1 

type BuildTargetCommitCompletedCompletedCommitRepo struct {
	Branch string `json:"branch,required"`
	Name   string `json:"name,required"`
	Owner  string `json:"owner,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Branch      resp.Field
		Name        resp.Field
		Owner       resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetCommitCompletedCompletedCommitRepo) RawJSON added in v0.1.1 

func (r BuildTargetCommitCompletedCompletedCommitRepo) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetCommitCompletedCompletedCommitRepo) UnmarshalJSON added in v0.1.1 

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

type BuildTargetCommitCompletedCompletedMergeConflictPr added in v0.1.1 

type BuildTargetCommitCompletedCompletedMergeConflictPr struct {
	Number float64                                                `json:"number,required"`
	Repo   BuildTargetCommitCompletedCompletedMergeConflictPrRepo `json:"repo,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Number      resp.Field
		Repo        resp.Field
		ExtraFields map[string]resp.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"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Name        resp.Field
		Owner       resp.Field
		ExtraFields map[string]resp.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"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Status      resp.Field
		ExtraFields map[string]resp.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"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Status      resp.Field
		ExtraFields map[string]resp.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"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Status      resp.Field
		ExtraFields map[string]resp.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    resp.Field
		Completed resp.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 BuildTargetCommitNotStarted:
case BuildTargetCommitQueued:
case BuildTargetCommitInProgress:
case 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 BuildTargetLintCompleted added in v0.1.1 

type BuildTargetLintCompleted struct {
	Completed BuildTargetLintCompletedCompleted `json:"completed,required"`
	Status    constant.Completed                `json:"status,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Completed   resp.Field
		Status      resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetLintCompleted) RawJSON added in v0.1.1 

func (r BuildTargetLintCompleted) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetLintCompleted) UnmarshalJSON added in v0.1.1 

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

type BuildTargetLintCompletedCompleted added in v0.1.1 

type BuildTargetLintCompletedCompleted struct {
	// Any of "success", "failure", "skipped", "cancelled", "action_required",
	// "neutral", "timed_out", "error", "warning", "note", "merge_conflict",
	// "upstream_merge_conflict", "fatal", "payment_required", "noop", "version_bump".
	Conclusion string `json:"conclusion,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Conclusion  resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetLintCompletedCompleted) RawJSON added in v0.1.1 

func (r BuildTargetLintCompletedCompleted) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetLintCompletedCompleted) UnmarshalJSON added in v0.1.1 

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

type BuildTargetLintInProgress added in v0.1.1 

type BuildTargetLintInProgress struct {
	Status constant.InProgress `json:"status,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Status      resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetLintInProgress) RawJSON added in v0.1.1 

func (r BuildTargetLintInProgress) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetLintInProgress) UnmarshalJSON added in v0.1.1 

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

type BuildTargetLintNotStarted added in v0.1.1 

type BuildTargetLintNotStarted struct {
	Status constant.NotStarted `json:"status,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Status      resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetLintNotStarted) RawJSON added in v0.1.1 

func (r BuildTargetLintNotStarted) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetLintNotStarted) UnmarshalJSON added in v0.1.1 

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

type BuildTargetLintQueued added in v0.1.1 

type BuildTargetLintQueued struct {
	Status constant.Queued `json:"status,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Status      resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetLintQueued) RawJSON added in v0.1.1 

func (r BuildTargetLintQueued) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetLintQueued) UnmarshalJSON added in v0.1.1 

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

type BuildTargetLintUnion 

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

BuildTargetLintUnion contains all possible properties and values from BuildTargetLintNotStarted, BuildTargetLintQueued, BuildTargetLintInProgress, BuildTargetLintCompleted.

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

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

func (BuildTargetLintUnion) AsAny added in v0.1.1 

func (u BuildTargetLintUnion) AsAny() anyBuildTargetLint

Use the following switch statement to find the correct variant 

switch variant := BuildTargetLintUnion.AsAny().(type) {
case BuildTargetLintNotStarted:
case BuildTargetLintQueued:
case BuildTargetLintInProgress:
case BuildTargetLintCompleted:
default:
  fmt.Errorf("no variant present")
}

func (BuildTargetLintUnion) AsCompleted added in v0.1.1 

func (u BuildTargetLintUnion) AsCompleted() (v BuildTargetLintCompleted)

func (BuildTargetLintUnion) AsInProgress added in v0.1.1 

func (u BuildTargetLintUnion) AsInProgress() (v BuildTargetLintInProgress)

func (BuildTargetLintUnion) AsNotStarted added in v0.1.1 

func (u BuildTargetLintUnion) AsNotStarted() (v BuildTargetLintNotStarted)

func (BuildTargetLintUnion) AsQueued added in v0.1.1 

func (u BuildTargetLintUnion) AsQueued() (v BuildTargetLintQueued)

func (BuildTargetLintUnion) RawJSON added in v0.1.1 

func (u BuildTargetLintUnion) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetLintUnion) UnmarshalJSON added in v0.1.1 

func (r *BuildTargetLintUnion) 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".
	Target BuildTargetOutputGetParamsTarget `query:"target,omitzero,required" json:"-"`
	// Type of output to download: source code
	//
	// Any of "source".
	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) IsPresent added in v0.2.0 

func (f BuildTargetOutputGetParams) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

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"
)

type BuildTargetOutputGetParamsType added in v0.2.0 

type BuildTargetOutputGetParamsType string

Type of output to download: source code 

const (
	BuildTargetOutputGetParamsTypeSource BuildTargetOutputGetParamsType = "source"
)

type BuildTargetOutputGetResponseObject added in v0.2.0 

type BuildTargetOutputGetResponseObject struct {
	// Any of "url".
	Output string `json:"output,required"`
	// URL for direct download
	URL string `json:"url,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Output      resp.Field
		URL         resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetOutputGetResponseObject) RawJSON added in v0.2.0 

func (r BuildTargetOutputGetResponseObject) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetOutputGetResponseObject) UnmarshalJSON added in v0.2.0 

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

type BuildTargetOutputGetResponseUnion added in v0.2.0 

type BuildTargetOutputGetResponseUnion struct {
	// This field is from variant [BuildTargetOutputGetResponseObject].
	Output string `json:"output"`
	// This field is from variant [BuildTargetOutputGetResponseObject].
	URL string `json:"url"`
	// This field is from variant [BuildTargetOutputGetResponseObject].
	Token string `json:"token"`
	// This field is from variant [BuildTargetOutputGetResponseObject].
	Ref  string `json:"ref"`
	JSON struct {
		Output resp.Field
		URL    resp.Field
		Token  resp.Field
		Ref    resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

BuildTargetOutputGetResponseUnion contains all possible properties and values from BuildTargetOutputGetResponseObject, BuildTargetOutputGetResponseObject.

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

func (BuildTargetOutputGetResponseUnion) AsBuildTargetOutputGetResponseObject added in v0.2.0 

func (u BuildTargetOutputGetResponseUnion) AsBuildTargetOutputGetResponseObject() (v BuildTargetOutputGetResponseObject)

func (BuildTargetOutputGetResponseUnion) AsunionMember2 added in v0.2.0 

func (u BuildTargetOutputGetResponseUnion) AsunionMember2() (v BuildTargetOutputGetResponseObject)

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-v0 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)

TODO

type BuildTargetStatus 

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

type BuildTargetTestCompleted added in v0.1.1 

type BuildTargetTestCompleted struct {
	Completed BuildTargetTestCompletedCompleted `json:"completed,required"`
	Status    constant.Completed                `json:"status,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Completed   resp.Field
		Status      resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetTestCompleted) RawJSON added in v0.1.1 

func (r BuildTargetTestCompleted) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetTestCompleted) UnmarshalJSON added in v0.1.1 

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

type BuildTargetTestCompletedCompleted added in v0.1.1 

type BuildTargetTestCompletedCompleted struct {
	// Any of "success", "failure", "skipped", "cancelled", "action_required",
	// "neutral", "timed_out", "error", "warning", "note", "merge_conflict",
	// "upstream_merge_conflict", "fatal", "payment_required", "noop", "version_bump".
	Conclusion string `json:"conclusion,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Conclusion  resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetTestCompletedCompleted) RawJSON added in v0.1.1 

func (r BuildTargetTestCompletedCompleted) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetTestCompletedCompleted) UnmarshalJSON added in v0.1.1 

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

type BuildTargetTestInProgress added in v0.1.1 

type BuildTargetTestInProgress struct {
	Status constant.InProgress `json:"status,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Status      resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetTestInProgress) RawJSON added in v0.1.1 

func (r BuildTargetTestInProgress) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetTestInProgress) UnmarshalJSON added in v0.1.1 

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

type BuildTargetTestNotStarted added in v0.1.1 

type BuildTargetTestNotStarted struct {
	Status constant.NotStarted `json:"status,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Status      resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetTestNotStarted) RawJSON added in v0.1.1 

func (r BuildTargetTestNotStarted) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetTestNotStarted) UnmarshalJSON added in v0.1.1 

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

type BuildTargetTestQueued added in v0.1.1 

type BuildTargetTestQueued struct {
	Status constant.Queued `json:"status,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Status      resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (BuildTargetTestQueued) RawJSON added in v0.1.1 

func (r BuildTargetTestQueued) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetTestQueued) UnmarshalJSON added in v0.1.1 

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

type BuildTargetTestUnion 

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

BuildTargetTestUnion contains all possible properties and values from BuildTargetTestNotStarted, BuildTargetTestQueued, BuildTargetTestInProgress, BuildTargetTestCompleted.

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

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

func (BuildTargetTestUnion) AsAny added in v0.1.1 

func (u BuildTargetTestUnion) AsAny() anyBuildTargetTest

Use the following switch statement to find the correct variant 

switch variant := BuildTargetTestUnion.AsAny().(type) {
case BuildTargetTestNotStarted:
case BuildTargetTestQueued:
case BuildTargetTestInProgress:
case BuildTargetTestCompleted:
default:
  fmt.Errorf("no variant present")
}

func (BuildTargetTestUnion) AsCompleted added in v0.1.1 

func (u BuildTargetTestUnion) AsCompleted() (v BuildTargetTestCompleted)

func (BuildTargetTestUnion) AsInProgress added in v0.1.1 

func (u BuildTargetTestUnion) AsInProgress() (v BuildTargetTestInProgress)

func (BuildTargetTestUnion) AsNotStarted added in v0.1.1 

func (u BuildTargetTestUnion) AsNotStarted() (v BuildTargetTestNotStarted)

func (BuildTargetTestUnion) AsQueued added in v0.1.1 

func (u BuildTargetTestUnion) AsQueued() (v BuildTargetTestQueued)

func (BuildTargetTestUnion) RawJSON added in v0.1.1 

func (u BuildTargetTestUnion) RawJSON() string

Returns the unmodified JSON received from the API

func (*BuildTargetTestUnion) UnmarshalJSON added in v0.1.1 

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

type Client 

type Client struct {
	Options            []option.RequestOption
	Projects           ProjectService
	Builds             BuildService
	BuildTargetOutputs BuildTargetOutputService
}

Client creates a struct with services and top level methods that help with interacting with the stainless-v0 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_V0_API_KEY, STAINLESS_V0_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 Error 

type Error = apierror.Error

type ProjectBranch added in v0.1.1 

type ProjectBranch struct {
	Branch       string                    `json:"branch,required"`
	ConfigCommit ProjectBranchConfigCommit `json:"config_commit,required"`
	LatestBuild  BuildObject               `json:"latest_build,required"`
	// Any of "project_branch".
	Object  ProjectBranchObject `json:"object,required"`
	Org     string              `json:"org,required"`
	Project string              `json:"project,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Branch       resp.Field
		ConfigCommit resp.Field
		LatestBuild  resp.Field
		Object       resp.Field
		Org          resp.Field
		Project      resp.Field
		ExtraFields  map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

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"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Repo        resp.Field
		Sha         resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

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"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Branch      resp.Field
		Name        resp.Field
		Owner       resp.Field
		ExtraFields map[string]resp.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 ProjectBranchNewParams added in v0.1.1 

type ProjectBranchNewParams struct {
	Branch     string          `json:"branch,required"`
	BranchFrom string          `json:"branch_from,required"`
	Force      param.Opt[bool] `json:"force,omitzero"`
	// contains filtered or unexported fields
}

func (ProjectBranchNewParams) IsPresent added in v0.1.1 

func (f ProjectBranchNewParams) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

func (ProjectBranchNewParams) MarshalJSON added in v0.1.1 

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

type ProjectBranchObject added in v0.1.1 

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

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-v0 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) Get added in v0.1.1 

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

TODO

func (*ProjectBranchService) New added in v0.1.1 

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

TODO

type ProjectConfigGetParams added in v0.2.0 

type ProjectConfigGetParams struct {
	// Branch name, defaults to "main"
	Branch param.Opt[string] `query:"branch,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (ProjectConfigGetParams) IsPresent added in v0.2.0 

func (f ProjectConfigGetParams) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

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"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Content     resp.Field
		ExtraFields map[string]resp.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 {
	// OpenAPI spec
	Spec string `json:"spec,required"`
	// Branch name
	Branch param.Opt[string] `json:"branch,omitzero"`
	// contains filtered or unexported fields
}

func (ProjectConfigGuessParams) IsPresent added in v0.2.0 

func (f ProjectConfigGuessParams) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

func (ProjectConfigGuessParams) MarshalJSON added in v0.2.0 

func (r ProjectConfigGuessParams) MarshalJSON() (data []byte, err 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"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		Content     resp.Field
		ExtraFields map[string]resp.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-v0 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, project string, query ProjectConfigGetParams, opts ...option.RequestOption) (res *ProjectConfigGetResponse, err error)

TODO

func (*ProjectConfigService) Guess added in v0.2.0 

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

TODO

type ProjectGetResponse added in v0.1.1 

type ProjectGetResponse struct {
	ConfigRepo  string `json:"config_repo,required"`
	DisplayName string `json:"display_name,required"`
	// Any of "project".
	Object ProjectGetResponseObject `json:"object,required"`
	Org    string                   `json:"org,required"`
	Slug   string                   `json:"slug,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		ConfigRepo  resp.Field
		DisplayName resp.Field
		Object      resp.Field
		Org         resp.Field
		Slug        resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (ProjectGetResponse) RawJSON added in v0.1.1 

func (r ProjectGetResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectGetResponse) UnmarshalJSON added in v0.1.1 

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

type ProjectGetResponseObject added in v0.1.1 

type ProjectGetResponseObject string
const (
	ProjectGetResponseObjectProject ProjectGetResponseObject = "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-v0 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, projectName string, opts ...option.RequestOption) (res *ProjectGetResponse, err error)

TODO

func (*ProjectService) Update added in v0.1.1 

func (r *ProjectService) Update(ctx context.Context, projectName string, body ProjectUpdateParams, opts ...option.RequestOption) (res *ProjectUpdateResponse, err error)

TODO

type ProjectUpdateParams added in v0.1.1 

type ProjectUpdateParams struct {
	DisplayName param.Opt[string] `json:"display_name,omitzero"`
	// contains filtered or unexported fields
}

func (ProjectUpdateParams) IsPresent added in v0.1.1 

func (f ProjectUpdateParams) IsPresent() bool

IsPresent returns true if the field's value is not omitted and not the JSON "null". To check if this field is omitted, use param.IsOmitted.

func (ProjectUpdateParams) MarshalJSON added in v0.1.1 

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

type ProjectUpdateResponse added in v0.1.1 

type ProjectUpdateResponse struct {
	ConfigRepo  string `json:"config_repo,required"`
	DisplayName string `json:"display_name,required"`
	// Any of "project".
	Object ProjectUpdateResponseObject `json:"object,required"`
	Org    string                      `json:"org,required"`
	Slug   string                      `json:"slug,required"`
	// Metadata for the response, check the presence of optional fields with the
	// [resp.Field.IsPresent] method.
	JSON struct {
		ConfigRepo  resp.Field
		DisplayName resp.Field
		Object      resp.Field
		Org         resp.Field
		Slug        resp.Field
		ExtraFields map[string]resp.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (ProjectUpdateResponse) RawJSON added in v0.1.1 

func (r ProjectUpdateResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*ProjectUpdateResponse) UnmarshalJSON added in v0.1.1 

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

type ProjectUpdateResponseObject added in v0.1.1 

type ProjectUpdateResponseObject string
const (
	ProjectUpdateResponseObjectProject ProjectUpdateResponseObject = "project"
)

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.21, 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.21, and used by the Go 1.24 encoding/json package.
paramutil
requestconfig
testutil
packages
param
resp
shared
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.