androidinstance.go

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

package limrun

import (
	"context"
	"errors"
	"fmt"
	"net/http"
	"net/url"
	"slices"
	"time"

	"github.com/limrun-inc/go-sdk/internal/apijson"
	"github.com/limrun-inc/go-sdk/internal/apiquery"
	"github.com/limrun-inc/go-sdk/internal/requestconfig"
	"github.com/limrun-inc/go-sdk/option"
	"github.com/limrun-inc/go-sdk/packages/pagination"
	"github.com/limrun-inc/go-sdk/packages/param"
	"github.com/limrun-inc/go-sdk/packages/respjson"
)

// 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.
type AndroidInstanceService struct {
	Options []option.RequestOption
}

// 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 NewAndroidInstanceService(opts ...option.RequestOption) (r AndroidInstanceService) {
	r = AndroidInstanceService{}
	r.Options = opts
	return
}

// Create an Android instance
func (r *AndroidInstanceService) New(ctx context.Context, params AndroidInstanceNewParams, opts ...option.RequestOption) (res *AndroidInstance, err error) {
	opts = slices.Concat(r.Options, opts)
	path := "v1/android_instances"
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &res, opts...)
	return
}

// List Android instances
func (r *AndroidInstanceService) List(ctx context.Context, query AndroidInstanceListParams, opts ...option.RequestOption) (res *pagination.Items[AndroidInstance], err error) {
	var raw *http.Response
	opts = slices.Concat(r.Options, opts)
	opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
	path := "v1/android_instances"
	cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, query, &res, opts...)
	if err != nil {
		return nil, err
	}
	err = cfg.Execute()
	if err != nil {
		return nil, err
	}
	res.SetPageConfig(cfg, raw)
	return res, nil
}

// List Android instances
func (r *AndroidInstanceService) ListAutoPaging(ctx context.Context, query AndroidInstanceListParams, opts ...option.RequestOption) *pagination.ItemsAutoPager[AndroidInstance] {
	return pagination.NewItemsAutoPager(r.List(ctx, query, opts...))
}

// Delete Android instance with given name
func (r *AndroidInstanceService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error) {
	opts = slices.Concat(r.Options, opts)
	opts = append([]option.RequestOption{option.WithHeader("Accept", "*/*")}, opts...)
	if id == "" {
		err = errors.New("missing required id parameter")
		return
	}
	path := fmt.Sprintf("v1/android_instances/%s", id)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodDelete, path, nil, nil, opts...)
	return
}

// Get Android instance with given ID
func (r *AndroidInstanceService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *AndroidInstance, err error) {
	opts = slices.Concat(r.Options, opts)
	if id == "" {
		err = errors.New("missing required id parameter")
		return
	}
	path := fmt.Sprintf("v1/android_instances/%s", id)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
	return
}

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
		raw         string
	} `json:"-"`
}

// Returns the unmodified JSON received from the API
func (r AndroidInstance) RawJSON() string { return r.JSON.raw }
func (r *AndroidInstance) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

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
		raw            string
	} `json:"-"`
}

// Returns the unmodified JSON received from the API
func (r AndroidInstanceMetadata) RawJSON() string { return r.JSON.raw }
func (r *AndroidInstanceMetadata) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

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
		raw               string
	} `json:"-"`
}

// Returns the unmodified JSON received from the API
func (r AndroidInstanceSpec) RawJSON() string { return r.JSON.raw }
func (r *AndroidInstanceSpec) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

type AndroidInstanceStatus struct {
	Token string `json:"token,required"`
	// Any of "unknown", "creating", "assigned", "ready", "terminated".
	State                   string                       `json:"state,required"`
	AdbWebSocketURL         string                       `json:"adbWebSocketUrl"`
	EndpointWebSocketURL    string                       `json:"endpointWebSocketUrl"`
	ErrorMessage            string                       `json:"errorMessage"`
	Sandbox                 AndroidInstanceStatusSandbox `json:"sandbox"`
	TargetHTTPPortURLPrefix string                       `json:"targetHttpPortUrlPrefix"`
	// 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
		ErrorMessage            respjson.Field
		Sandbox                 respjson.Field
		TargetHTTPPortURLPrefix respjson.Field
		ExtraFields             map[string]respjson.Field
		raw                     string
	} `json:"-"`
}

// Returns the unmodified JSON received from the API
func (r AndroidInstanceStatus) RawJSON() string { return r.JSON.raw }
func (r *AndroidInstanceStatus) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

type AndroidInstanceStatusSandbox struct {
	PlaywrightAndroid AndroidInstanceStatusSandboxPlaywrightAndroid `json:"playwrightAndroid"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		PlaywrightAndroid respjson.Field
		ExtraFields       map[string]respjson.Field
		raw               string
	} `json:"-"`
}

// Returns the unmodified JSON received from the API
func (r AndroidInstanceStatusSandbox) RawJSON() string { return r.JSON.raw }
func (r *AndroidInstanceStatusSandbox) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

type AndroidInstanceStatusSandboxPlaywrightAndroid struct {
	URL string `json:"url"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		raw         string
	} `json:"-"`
}

// Returns the unmodified JSON received from the API
func (r AndroidInstanceStatusSandboxPlaywrightAndroid) RawJSON() string { return r.JSON.raw }
func (r *AndroidInstanceStatusSandboxPlaywrightAndroid) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

type AndroidInstanceNewParams struct {
	// If there is another instance with given labels and region, return that one
	// instead of creating a new instance.
	ReuseIfExists param.Opt[bool] `query:"reuseIfExists,omitzero" json:"-"`
	// 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"`
	paramObj
}

func (r AndroidInstanceNewParams) MarshalJSON() (data []byte, err error) {
	type shadow AndroidInstanceNewParams
	return param.MarshalObject(r, (*shadow)(&r))
}
func (r *AndroidInstanceNewParams) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

// URLQuery serializes [AndroidInstanceNewParams]'s query parameters as
// `url.Values`.
func (r AndroidInstanceNewParams) URLQuery() (v url.Values, err error) {
	return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
		ArrayFormat:  apiquery.ArrayQueryFormatComma,
		NestedFormat: apiquery.NestedQueryFormatBrackets,
	})
}

type AndroidInstanceNewParamsMetadata struct {
	DisplayName param.Opt[string] `json:"displayName,omitzero"`
	Labels      map[string]string `json:"labels,omitzero"`
	paramObj
}

func (r AndroidInstanceNewParamsMetadata) MarshalJSON() (data []byte, err error) {
	type shadow AndroidInstanceNewParamsMetadata
	return param.MarshalObject(r, (*shadow)(&r))
}
func (r *AndroidInstanceNewParamsMetadata) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

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"`
	Sandbox       AndroidInstanceNewParamsSpecSandbox        `json:"sandbox,omitzero"`
	paramObj
}

func (r AndroidInstanceNewParamsSpec) MarshalJSON() (data []byte, err error) {
	type shadow AndroidInstanceNewParamsSpec
	return param.MarshalObject(r, (*shadow)(&r))
}
func (r *AndroidInstanceNewParamsSpec) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

// The property Kind is required.
type AndroidInstanceNewParamsSpecClue struct {
	// Any of "ClientIP", "OSVersion".
	Kind     string            `json:"kind,omitzero,required"`
	ClientIP param.Opt[string] `json:"clientIp,omitzero"`
	// The major version of Android, e.g. "13", "14" or "15".
	OsVersion param.Opt[string] `json:"osVersion,omitzero"`
	paramObj
}

func (r AndroidInstanceNewParamsSpecClue) MarshalJSON() (data []byte, err error) {
	type shadow AndroidInstanceNewParamsSpecClue
	return param.MarshalObject(r, (*shadow)(&r))
}
func (r *AndroidInstanceNewParamsSpecClue) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

func init() {
	apijson.RegisterFieldValidator[AndroidInstanceNewParamsSpecClue](
		"kind", "ClientIP", "OSVersion",
	)
}

// The property Kind is required.
type AndroidInstanceNewParamsSpecInitialAsset struct {
	// Any of "App", "Configuration".
	Kind          string                                                `json:"kind,omitzero,required"`
	AssetName     param.Opt[string]                                     `json:"assetName,omitzero"`
	URL           param.Opt[string]                                     `json:"url,omitzero"`
	AssetIDs      []string                                              `json:"assetIds,omitzero"`
	AssetNames    []string                                              `json:"assetNames,omitzero"`
	Configuration AndroidInstanceNewParamsSpecInitialAssetConfiguration `json:"configuration,omitzero"`
	// Any of "URL", "URLs", "AssetName", "AssetNames", "AssetIDs".
	Source string   `json:"source,omitzero"`
	URLs   []string `json:"urls,omitzero"`
	paramObj
}

func (r AndroidInstanceNewParamsSpecInitialAsset) MarshalJSON() (data []byte, err error) {
	type shadow AndroidInstanceNewParamsSpecInitialAsset
	return param.MarshalObject(r, (*shadow)(&r))
}
func (r *AndroidInstanceNewParamsSpecInitialAsset) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

func init() {
	apijson.RegisterFieldValidator[AndroidInstanceNewParamsSpecInitialAsset](
		"kind", "App", "Configuration",
	)
	apijson.RegisterFieldValidator[AndroidInstanceNewParamsSpecInitialAsset](
		"source", "URL", "URLs", "AssetName", "AssetNames", "AssetIDs",
	)
}

// The property Kind is required.
type AndroidInstanceNewParamsSpecInitialAssetConfiguration struct {
	// Any of "ChromeFlag".
	Kind string `json:"kind,omitzero,required"`
	// Any of "enable-command-line-on-non-rooted-devices@1".
	ChromeFlag string `json:"chromeFlag,omitzero"`
	paramObj
}

func (r AndroidInstanceNewParamsSpecInitialAssetConfiguration) MarshalJSON() (data []byte, err error) {
	type shadow AndroidInstanceNewParamsSpecInitialAssetConfiguration
	return param.MarshalObject(r, (*shadow)(&r))
}
func (r *AndroidInstanceNewParamsSpecInitialAssetConfiguration) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

func init() {
	apijson.RegisterFieldValidator[AndroidInstanceNewParamsSpecInitialAssetConfiguration](
		"kind", "ChromeFlag",
	)
	apijson.RegisterFieldValidator[AndroidInstanceNewParamsSpecInitialAssetConfiguration](
		"chromeFlag", "enable-command-line-on-non-rooted-devices@1",
	)
}

type AndroidInstanceNewParamsSpecSandbox struct {
	PlaywrightAndroid AndroidInstanceNewParamsSpecSandboxPlaywrightAndroid `json:"playwrightAndroid,omitzero"`
	paramObj
}

func (r AndroidInstanceNewParamsSpecSandbox) MarshalJSON() (data []byte, err error) {
	type shadow AndroidInstanceNewParamsSpecSandbox
	return param.MarshalObject(r, (*shadow)(&r))
}
func (r *AndroidInstanceNewParamsSpecSandbox) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

type AndroidInstanceNewParamsSpecSandboxPlaywrightAndroid struct {
	Enabled param.Opt[bool] `json:"enabled,omitzero"`
	paramObj
}

func (r AndroidInstanceNewParamsSpecSandboxPlaywrightAndroid) MarshalJSON() (data []byte, err error) {
	type shadow AndroidInstanceNewParamsSpecSandboxPlaywrightAndroid
	return param.MarshalObject(r, (*shadow)(&r))
}
func (r *AndroidInstanceNewParamsSpecSandboxPlaywrightAndroid) UnmarshalJSON(data []byte) error {
	return apijson.UnmarshalRoot(data, r)
}

type AndroidInstanceListParams struct {
	EndingBefore param.Opt[string] `query:"endingBefore,omitzero" json:"-"`
	// 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:"-"`
	// Maximum number of instances to be returned. The default is 50.
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Region where the instance is scheduled on.
	Region        param.Opt[string] `query:"region,omitzero" json:"-"`
	StartingAfter param.Opt[string] `query:"startingAfter,omitzero" json:"-"`
	// State filter to apply to Android instances to return. Each comma-separated state
	// will be used as part of an OR clause, e.g. "assigned,ready" will return all
	// instances that are either assigned or ready.
	//
	// Valid states: creating, assigned, ready, terminated, unknown
	State param.Opt[string] `query:"state,omitzero" json:"-"`
	paramObj
}

// URLQuery serializes [AndroidInstanceListParams]'s query parameters as
// `url.Values`.
func (r AndroidInstanceListParams) URLQuery() (v url.Values, err error) {
	return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
		ArrayFormat:  apiquery.ArrayQueryFormatComma,
		NestedFormat: apiquery.NestedQueryFormatBrackets,
	})
}