limrun

package module
v0.4.1 Latest Latest
Warning

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

 Go to latest Published: Sep 18, 2025 License: Apache-2.0 Imports: 17 Imported by: 0

README

Limrun Go API Library

Go Reference

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

It is generated with Stainless.

Installation

import (
	"github.com/limrun-inc/go-sdk" // imported as limrun
)

Or to pin the version:

go get -u 'github.com/limrun-inc/go-sdk@v0.4.1'

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/limrun-inc/go-sdk"
	"github.com/limrun-inc/go-sdk/option"
)

func main() {
	client := limrun.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("LIM_TOKEN")
	)
	androidInstance, err := client.AndroidInstances.New(context.TODO(), limrun.AndroidInstanceNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", androidInstance.Metadata)
}
Request fields

The limrun 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, limrun.String(string), limrun.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 := limrun.ExampleParams{
	ID:   "id_xxx",             // required property
	Name: limrun.String("..."), // optional property

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

	Origin: limrun.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[limrun.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 := limrun.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

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

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 *limrun.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.AndroidInstances.New(context.TODO(), limrun.AndroidInstanceNewParams{})
if err != nil {
	var apierr *limrun.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 "/v1/android_instances": 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.AndroidInstances.New(
	ctx,
	limrun.AndroidInstanceNewParams{},
	// 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 limrun.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 := limrun.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.AndroidInstances.New(
	context.TODO(),
	limrun.AndroidInstanceNewParams{},
	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
androidInstance, err := client.AndroidInstances.New(
	context.TODO(),
	limrun.AndroidInstanceNewParams{},
	option.WithResponseInto(&response),
)
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", androidInstance)

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

func BoolPtr(v bool) *bool

func DefaultClientOptions 

func DefaultClientOptions() []option.RequestOption

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

func File 

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

func Float 

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

func FloatPtr 

func FloatPtr(v float64) *float64

func Int 

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

func IntPtr 

func IntPtr(v int64) *int64

func Opt 

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

func Ptr 

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

func String 

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

func StringPtr 

func StringPtr(v string) *string

func Time 

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

func TimePtr 

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

Types

type AndroidInstance 

type AndroidInstance struct {
	Metadata AndroidInstanceMetadata `json:"metadata,required"`
	Spec     AndroidInstanceSpec     `json:"spec,required"`
	Status   AndroidInstanceStatus   `json:"status,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Metadata    respjson.Field
		Spec        respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AndroidInstance) RawJSON 

func (r AndroidInstance) RawJSON() string

Returns the unmodified JSON received from the API

func (*AndroidInstance) UnmarshalJSON 

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

type AndroidInstanceListParams 

type AndroidInstanceListParams struct {
	// Labels filter to apply to Android instances to return. Expects a comma-separated
	// list of key=value pairs (e.g., env=prod,region=us-west).
	LabelSelector param.Opt[string] `query:"labelSelector,omitzero" json:"-"`
	// Region where the instance is scheduled on.
	Region param.Opt[string] `query:"region,omitzero" json:"-"`
	// State filter to apply to Android instances to return.
	//
	// Any of "unknown", "creating", "ready", "terminated".
	State AndroidInstanceListParamsState `query:"state,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (AndroidInstanceListParams) URLQuery 

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

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

type AndroidInstanceListParamsState 

type AndroidInstanceListParamsState string

State filter to apply to Android instances to return. 

const (
	AndroidInstanceListParamsStateUnknown    AndroidInstanceListParamsState = "unknown"
	AndroidInstanceListParamsStateCreating   AndroidInstanceListParamsState = "creating"
	AndroidInstanceListParamsStateReady      AndroidInstanceListParamsState = "ready"
	AndroidInstanceListParamsStateTerminated AndroidInstanceListParamsState = "terminated"
)

type AndroidInstanceMetadata 

type AndroidInstanceMetadata struct {
	ID             string            `json:"id,required"`
	CreatedAt      time.Time         `json:"createdAt,required" format:"date-time"`
	OrganizationID string            `json:"organizationId,required"`
	DisplayName    string            `json:"displayName"`
	Labels         map[string]string `json:"labels"`
	TerminatedAt   time.Time         `json:"terminatedAt" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		CreatedAt      respjson.Field
		OrganizationID respjson.Field
		DisplayName    respjson.Field
		Labels         respjson.Field
		TerminatedAt   respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AndroidInstanceMetadata) RawJSON 

func (r AndroidInstanceMetadata) RawJSON() string

Returns the unmodified JSON received from the API

func (*AndroidInstanceMetadata) UnmarshalJSON 

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

type AndroidInstanceNewParams 

type AndroidInstanceNewParams struct {
	// Return after the instance is ready to connect.
	Wait     param.Opt[bool]                  `query:"wait,omitzero" json:"-"`
	Metadata AndroidInstanceNewParamsMetadata `json:"metadata,omitzero"`
	Spec     AndroidInstanceNewParamsSpec     `json:"spec,omitzero"`
	// contains filtered or unexported fields
}

func (AndroidInstanceNewParams) MarshalJSON 

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

func (AndroidInstanceNewParams) URLQuery 

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

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

func (*AndroidInstanceNewParams) UnmarshalJSON 

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

type AndroidInstanceNewParamsMetadata 

type AndroidInstanceNewParamsMetadata struct {
	DisplayName param.Opt[string] `json:"displayName,omitzero"`
	Labels      map[string]string `json:"labels,omitzero"`
	// contains filtered or unexported fields
}

func (AndroidInstanceNewParamsMetadata) MarshalJSON 

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

func (*AndroidInstanceNewParamsMetadata) UnmarshalJSON 

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

type AndroidInstanceNewParamsSpec 

type AndroidInstanceNewParamsSpec struct {
	// After how many minutes should the instance be terminated. Example values 1m,
	// 10m, 3h. Default is "0" which means no hard timeout.
	HardTimeout param.Opt[string] `json:"hardTimeout,omitzero" format:"duration"`
	// After how many minutes of inactivity should the instance be terminated. Example
	// values 1m, 10m, 3h. Default is 3m. Providing "0" disables inactivity checks
	// altogether.
	InactivityTimeout param.Opt[string] `json:"inactivityTimeout,omitzero" format:"duration"`
	// The region where the instance will be created. If not given, will be decided
	// based on scheduling clues and availability.
	Region        param.Opt[string]                          `json:"region,omitzero"`
	Clues         []AndroidInstanceNewParamsSpecClue         `json:"clues,omitzero"`
	InitialAssets []AndroidInstanceNewParamsSpecInitialAsset `json:"initialAssets,omitzero"`
	// contains filtered or unexported fields
}

func (AndroidInstanceNewParamsSpec) MarshalJSON 

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

func (*AndroidInstanceNewParamsSpec) UnmarshalJSON 

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

type AndroidInstanceNewParamsSpecClue 

type AndroidInstanceNewParamsSpecClue struct {
	// Any of "ClientIP".
	Kind     string            `json:"kind,omitzero,required"`
	ClientIP param.Opt[string] `json:"clientIp,omitzero"`
	// contains filtered or unexported fields
}

The property Kind is required.

func (AndroidInstanceNewParamsSpecClue) MarshalJSON 

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

func (*AndroidInstanceNewParamsSpecClue) UnmarshalJSON 

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

type AndroidInstanceNewParamsSpecInitialAsset 

type AndroidInstanceNewParamsSpecInitialAsset struct {
	// Any of "App".
	Kind string `json:"kind,omitzero,required"`
	// Any of "URL", "AssetName".
	Source    string            `json:"source,omitzero,required"`
	AssetName param.Opt[string] `json:"assetName,omitzero"`
	URL       param.Opt[string] `json:"url,omitzero"`
	// contains filtered or unexported fields
}

The properties Kind, Source are required.

func (AndroidInstanceNewParamsSpecInitialAsset) MarshalJSON 

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

func (*AndroidInstanceNewParamsSpecInitialAsset) UnmarshalJSON 

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

type AndroidInstanceService 

type AndroidInstanceService struct {
	Options []option.RequestOption
}

AndroidInstanceService contains methods and other services that help with interacting with the limrun 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 NewAndroidInstanceService method instead.

func NewAndroidInstanceService 

func NewAndroidInstanceService(opts ...option.RequestOption) (r AndroidInstanceService)

NewAndroidInstanceService 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 (*AndroidInstanceService) Delete 

func (r *AndroidInstanceService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

Delete Android instance with given name

func (*AndroidInstanceService) Get 

func (r *AndroidInstanceService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *AndroidInstance, err error)

Get Android instance with given ID

func (*AndroidInstanceService) List 

func (r *AndroidInstanceService) List(ctx context.Context, query AndroidInstanceListParams, opts ...option.RequestOption) (res *[]AndroidInstance, err error)

List Android instances belonging to given organization

func (*AndroidInstanceService) New 

func (r *AndroidInstanceService) New(ctx context.Context, params AndroidInstanceNewParams, opts ...option.RequestOption) (res *AndroidInstance, err error)

Create an Android instance

type AndroidInstanceSpec 

type AndroidInstanceSpec struct {
	// After how many minutes of inactivity should the instance be terminated. Example
	// values 1m, 10m, 3h. Default is 3m. Providing "0" disables inactivity checks
	// altogether.
	InactivityTimeout string `json:"inactivityTimeout,required" format:"duration"`
	// The region where the instance will be created. If not given, will be decided
	// based on scheduling clues and availability.
	Region string `json:"region,required"`
	// After how many minutes should the instance be terminated. Example values 1m,
	// 10m, 3h. Default is "0" which means no hard timeout.
	HardTimeout string `json:"hardTimeout" format:"duration"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		InactivityTimeout respjson.Field
		Region            respjson.Field
		HardTimeout       respjson.Field
		ExtraFields       map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AndroidInstanceSpec) RawJSON 

func (r AndroidInstanceSpec) RawJSON() string

Returns the unmodified JSON received from the API

func (*AndroidInstanceSpec) UnmarshalJSON 

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

type AndroidInstanceStatus 

type AndroidInstanceStatus struct {
	Token string `json:"token,required"`
	// Any of "unknown", "creating", "ready", "terminated".
	State                string `json:"state,required"`
	AdbWebSocketURL      string `json:"adbWebSocketUrl"`
	EndpointWebSocketURL string `json:"endpointWebSocketUrl"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Token                respjson.Field
		State                respjson.Field
		AdbWebSocketURL      respjson.Field
		EndpointWebSocketURL respjson.Field
		ExtraFields          map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AndroidInstanceStatus) RawJSON 

func (r AndroidInstanceStatus) RawJSON() string

Returns the unmodified JSON received from the API

func (*AndroidInstanceStatus) UnmarshalJSON 

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

type Asset 

type Asset struct {
	ID   string `json:"id,required"`
	Name string `json:"name,required"`
	// Returned only if there is a corresponding file uploaded already.
	Md5               string `json:"md5"`
	SignedDownloadURL string `json:"signedDownloadUrl"`
	SignedUploadURL   string `json:"signedUploadUrl"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                respjson.Field
		Name              respjson.Field
		Md5               respjson.Field
		SignedDownloadURL respjson.Field
		SignedUploadURL   respjson.Field
		ExtraFields       map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (Asset) RawJSON 

func (r Asset) RawJSON() string

Returns the unmodified JSON received from the API

func (*Asset) UnmarshalJSON 

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

type AssetGetOrNewParams 

type AssetGetOrNewParams struct {
	Name string `json:"name,required"`
	// contains filtered or unexported fields
}

func (AssetGetOrNewParams) MarshalJSON 

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

func (*AssetGetOrNewParams) UnmarshalJSON 

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

type AssetGetOrNewResponse 

type AssetGetOrNewResponse struct {
	ID                string `json:"id,required"`
	Name              string `json:"name,required"`
	SignedDownloadURL string `json:"signedDownloadUrl,required"`
	SignedUploadURL   string `json:"signedUploadUrl,required"`
	// Returned only if there is a corresponding file uploaded already.
	Md5 string `json:"md5"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                respjson.Field
		Name              respjson.Field
		SignedDownloadURL respjson.Field
		SignedUploadURL   respjson.Field
		Md5               respjson.Field
		ExtraFields       map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (AssetGetOrNewResponse) RawJSON 

func (r AssetGetOrNewResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*AssetGetOrNewResponse) UnmarshalJSON 

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

type AssetGetOrUploadParams 

type AssetGetOrUploadParams struct {
	// Name of the asset. If not given, file name of the given file is used.
	Name param.Opt[string]

	// Path to the file to upload.
	Path string

	// ProgressWriter is an optional io.Writer to track upload progress.
	// If provided, upload progress will be written to this writer.
	ProgressWriter io.Writer
}

type AssetGetParams 

type AssetGetParams struct {
	// Toggles whether a download URL should be included in the response
	IncludeDownloadURL param.Opt[bool] `query:"includeDownloadUrl,omitzero" json:"-"`
	// Toggles whether an upload URL should be included in the response
	IncludeUploadURL param.Opt[bool] `query:"includeUploadUrl,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (AssetGetParams) URLQuery 

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

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

type AssetListParams 

type AssetListParams struct {
	// Toggles whether a download URL should be included in the response
	IncludeDownloadURL param.Opt[bool] `query:"includeDownloadUrl,omitzero" json:"-"`
	// Toggles whether an upload URL should be included in the response
	IncludeUploadURL param.Opt[bool] `query:"includeUploadUrl,omitzero" json:"-"`
	// Query by file name
	NameFilter param.Opt[string] `query:"nameFilter,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (AssetListParams) URLQuery 

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

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

type AssetService 

type AssetService struct {
	Options []option.RequestOption
}

AssetService contains methods and other services that help with interacting with the limrun 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 NewAssetService method instead.

func NewAssetService 

func NewAssetService(opts ...option.RequestOption) (r AssetService)

NewAssetService 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 (*AssetService) Get 

func (r *AssetService) Get(ctx context.Context, assetID string, query AssetGetParams, opts ...option.RequestOption) (res *Asset, err error)

Get the asset with given ID.

func (*AssetService) GetOrNew 

func (r *AssetService) GetOrNew(ctx context.Context, body AssetGetOrNewParams, opts ...option.RequestOption) (res *AssetGetOrNewResponse, err error)

Creates an asset and returns upload and download URLs. If there is a corresponding file uploaded in the storage with given name, its MD5 is returned so you can check if a re-upload is necessary. If no MD5 is returned, then there is no corresponding file in the storage so downloading it directly or using it in instances will fail until you use the returned upload URL to submit the file.

func (*AssetService) GetOrUpload 

func (r *AssetService) GetOrUpload(ctx context.Context, body AssetGetOrUploadParams, opts ...option.RequestOption) (res *AssetGetOrNewResponse, err error)

GetOrUpload makes sure the given file is either uploaded or validates that it was uploaded and return a working download URL in either case.

func (*AssetService) List 

func (r *AssetService) List(ctx context.Context, query AssetListParams, opts ...option.RequestOption) (res *[]Asset, err error)

List organization's all assets with given filters. If none given, return all assets.

type Client 

type Client struct {
	Options          []option.RequestOption
	AndroidInstances AndroidInstanceService
	Assets           AssetService
	IosInstances     IosInstanceService
}

Client creates a struct with services and top level methods that help with interacting with the limrun 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 (LIM_TOKEN, LIMRUN_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 IosInstance added in v0.4.1 

type IosInstance struct {
	Metadata IosInstanceMetadata `json:"metadata,required"`
	Spec     IosInstanceSpec     `json:"spec,required"`
	Status   IosInstanceStatus   `json:"status,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Metadata    respjson.Field
		Spec        respjson.Field
		Status      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IosInstance) RawJSON added in v0.4.1 

func (r IosInstance) RawJSON() string

Returns the unmodified JSON received from the API

func (*IosInstance) UnmarshalJSON added in v0.4.1 

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

type IosInstanceListParams added in v0.4.1 

type IosInstanceListParams struct {
	// Labels filter to apply to instances to return. Expects a comma-separated list of
	// key=value pairs (e.g., env=prod,region=us-west).
	LabelSelector param.Opt[string] `query:"labelSelector,omitzero" json:"-"`
	// Region where the instance is scheduled on.
	Region param.Opt[string] `query:"region,omitzero" json:"-"`
	// State filter to apply to instances to return.
	//
	// Any of "unknown", "creating", "ready", "terminated".
	State IosInstanceListParamsState `query:"state,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (IosInstanceListParams) URLQuery added in v0.4.1 

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

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

type IosInstanceListParamsState added in v0.4.1 

type IosInstanceListParamsState string

State filter to apply to instances to return. 

const (
	IosInstanceListParamsStateUnknown    IosInstanceListParamsState = "unknown"
	IosInstanceListParamsStateCreating   IosInstanceListParamsState = "creating"
	IosInstanceListParamsStateReady      IosInstanceListParamsState = "ready"
	IosInstanceListParamsStateTerminated IosInstanceListParamsState = "terminated"
)

type IosInstanceMetadata added in v0.4.1 

type IosInstanceMetadata struct {
	ID             string            `json:"id,required"`
	CreatedAt      time.Time         `json:"createdAt,required" format:"date-time"`
	OrganizationID string            `json:"organizationId,required"`
	DisplayName    string            `json:"displayName"`
	Labels         map[string]string `json:"labels"`
	TerminatedAt   time.Time         `json:"terminatedAt" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		CreatedAt      respjson.Field
		OrganizationID respjson.Field
		DisplayName    respjson.Field
		Labels         respjson.Field
		TerminatedAt   respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IosInstanceMetadata) RawJSON added in v0.4.1 

func (r IosInstanceMetadata) RawJSON() string

Returns the unmodified JSON received from the API

func (*IosInstanceMetadata) UnmarshalJSON added in v0.4.1 

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

type IosInstanceNewParams added in v0.4.1 

type IosInstanceNewParams struct {
	// Return after the instance is ready to connect.
	Wait     param.Opt[bool]              `query:"wait,omitzero" json:"-"`
	Metadata IosInstanceNewParamsMetadata `json:"metadata,omitzero"`
	Spec     IosInstanceNewParamsSpec     `json:"spec,omitzero"`
	// contains filtered or unexported fields
}

func (IosInstanceNewParams) MarshalJSON added in v0.4.1 

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

func (IosInstanceNewParams) URLQuery added in v0.4.1 

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

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

func (*IosInstanceNewParams) UnmarshalJSON added in v0.4.1 

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

type IosInstanceNewParamsMetadata added in v0.4.1 

type IosInstanceNewParamsMetadata struct {
	DisplayName param.Opt[string] `json:"displayName,omitzero"`
	Labels      map[string]string `json:"labels,omitzero"`
	// contains filtered or unexported fields
}

func (IosInstanceNewParamsMetadata) MarshalJSON added in v0.4.1 

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

func (*IosInstanceNewParamsMetadata) UnmarshalJSON added in v0.4.1 

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

type IosInstanceNewParamsSpec added in v0.4.1 

type IosInstanceNewParamsSpec struct {
	// After how many minutes should the instance be terminated. Example values 1m,
	// 10m, 3h. Default is "0" which means no hard timeout.
	HardTimeout param.Opt[string] `json:"hardTimeout,omitzero" format:"duration"`
	// After how many minutes of inactivity should the instance be terminated. Example
	// values 1m, 10m, 3h. Default is 3m. Providing "0" disables inactivity checks
	// altogether.
	InactivityTimeout param.Opt[string] `json:"inactivityTimeout,omitzero" format:"duration"`
	// The region where the instance will be created. If not given, will be decided
	// based on scheduling clues and availability.
	Region        param.Opt[string]                      `json:"region,omitzero"`
	Clues         []IosInstanceNewParamsSpecClue         `json:"clues,omitzero"`
	InitialAssets []IosInstanceNewParamsSpecInitialAsset `json:"initialAssets,omitzero"`
	// contains filtered or unexported fields
}

func (IosInstanceNewParamsSpec) MarshalJSON added in v0.4.1 

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

func (*IosInstanceNewParamsSpec) UnmarshalJSON added in v0.4.1 

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

type IosInstanceNewParamsSpecClue added in v0.4.1 

type IosInstanceNewParamsSpecClue struct {
	// Any of "ClientIP".
	Kind     string            `json:"kind,omitzero,required"`
	ClientIP param.Opt[string] `json:"clientIp,omitzero"`
	// contains filtered or unexported fields
}

The property Kind is required.

func (IosInstanceNewParamsSpecClue) MarshalJSON added in v0.4.1 

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

func (*IosInstanceNewParamsSpecClue) UnmarshalJSON added in v0.4.1 

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

type IosInstanceNewParamsSpecInitialAsset added in v0.4.1 

type IosInstanceNewParamsSpecInitialAsset struct {
	// Any of "App".
	Kind string `json:"kind,omitzero,required"`
	// Any of "URL", "AssetName".
	Source    string            `json:"source,omitzero,required"`
	AssetName param.Opt[string] `json:"assetName,omitzero"`
	URL       param.Opt[string] `json:"url,omitzero"`
	// contains filtered or unexported fields
}

The properties Kind, Source are required.

func (IosInstanceNewParamsSpecInitialAsset) MarshalJSON added in v0.4.1 

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

func (*IosInstanceNewParamsSpecInitialAsset) UnmarshalJSON added in v0.4.1 

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

type IosInstanceService added in v0.4.1 

type IosInstanceService struct {
	Options []option.RequestOption
}

IosInstanceService contains methods and other services that help with interacting with the limrun 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 NewIosInstanceService method instead.

func NewIosInstanceService added in v0.4.1 

func NewIosInstanceService(opts ...option.RequestOption) (r IosInstanceService)

NewIosInstanceService 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 (*IosInstanceService) Delete added in v0.4.1 

func (r *IosInstanceService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)

Delete iOS instance with given name

func (*IosInstanceService) Get added in v0.4.1 

func (r *IosInstanceService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *IosInstance, err error)

Get iOS instance with given ID

func (*IosInstanceService) List added in v0.4.1 

func (r *IosInstanceService) List(ctx context.Context, query IosInstanceListParams, opts ...option.RequestOption) (res *[]IosInstance, err error)

List iOS instances

func (*IosInstanceService) New added in v0.4.1 

func (r *IosInstanceService) New(ctx context.Context, params IosInstanceNewParams, opts ...option.RequestOption) (res *IosInstance, err error)

Create an iOS instance

type IosInstanceSpec added in v0.4.1 

type IosInstanceSpec struct {
	// After how many minutes of inactivity should the instance be terminated. Example
	// values 1m, 10m, 3h. Default is 3m. Providing "0" disables inactivity checks
	// altogether.
	InactivityTimeout string `json:"inactivityTimeout,required" format:"duration"`
	// The region where the instance will be created. If not given, will be decided
	// based on scheduling clues and availability.
	Region string `json:"region,required"`
	// After how many minutes should the instance be terminated. Example values 1m,
	// 10m, 3h. Default is "0" which means no hard timeout.
	HardTimeout string `json:"hardTimeout" format:"duration"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		InactivityTimeout respjson.Field
		Region            respjson.Field
		HardTimeout       respjson.Field
		ExtraFields       map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IosInstanceSpec) RawJSON added in v0.4.1 

func (r IosInstanceSpec) RawJSON() string

Returns the unmodified JSON received from the API

func (*IosInstanceSpec) UnmarshalJSON added in v0.4.1 

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

type IosInstanceStatus added in v0.4.1 

type IosInstanceStatus struct {
	Token string `json:"token,required"`
	// Any of "unknown", "creating", "ready", "terminated".
	State                string `json:"state,required"`
	EndpointWebSocketURL string `json:"endpointWebSocketUrl"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Token                respjson.Field
		State                respjson.Field
		EndpointWebSocketURL respjson.Field
		ExtraFields          map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (IosInstanceStatus) RawJSON added in v0.4.1 

func (r IosInstanceStatus) RawJSON() string

Returns the unmodified JSON received from the API

func (*IosInstanceStatus) UnmarshalJSON added in v0.4.1 

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

Source Files

View all Source files

Directories

Path Synopsis
examples
assets command
server command
tunnel command
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
respjson
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.