simplechecks

README

Simplechecks Go API Library

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

It is generated with Stainless.

Installation

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

Or to pin the version:

go get -u 'github.com/simplechecks/simplechecks-sdk-go@v0.0.2'

Requirements

This library requires Go 1.22+.

Usage

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

package main

import (
	"context"
	"fmt"

	"github.com/simplechecks/simplechecks-sdk-go"
	"github.com/simplechecks/simplechecks-sdk-go/option"
)

func main() {
	client := simplechecks.NewClient(
		option.WithAPIKey("My API Key"),      // defaults to os.LookupEnv("SIMPLECHECKS_API_KEY")
		option.WithEnvironmentEnvironment1(), // defaults to option.WithEnvironmentProduction()
	)
	response, err := client.Healthz.Check(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Status)
}

Request fields

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

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

	Origin: simplechecks.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[simplechecks.FooParams](12)

Request unions

Unions are represented as a struct with fields prefixed by "Of" for each of its 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 := simplechecks.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Healthz.Check(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 *simplechecks.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.Healthz.Check(context.TODO())
if err != nil {
	var apierr *simplechecks.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 "/healthz": 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.Healthz.Check(
	ctx,
	// 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 simplechecks.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 := simplechecks.NewClient(
	option.WithMaxRetries(0), // default is 2
)

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

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

• func Bool(b bool) param.Opt[bool]
• func BoolPtr(v bool) *bool
• func DefaultClientOptions() []option.RequestOption
• func File(rdr io.Reader, filename string, contentType string) file
• func Float(f float64) param.Opt[float64]
• func FloatPtr(v float64) *float64
• func Int(i int64) param.Opt[int64]
• func IntPtr(v int64) *int64
• func Opt[T comparable](v T) param.Opt[T]
• func Ptr[T any](v T) *T
• func String(s string) param.Opt[string]
• func StringPtr(v string) *string
• func Time(t time.Time) param.Opt[time.Time]
• func TimePtr(v time.Time) *time.Time
• type AccountGetResponse
  • func (r AccountGetResponse) RawJSON() string
  • func (r *AccountGetResponse) UnmarshalJSON(data []byte) error
• type AccountService
  • func NewAccountService(opts ...option.RequestOption) (r AccountService)
  • func (r *AccountService) Get(ctx context.Context, opts ...option.RequestOption) (res *AccountGetResponse, err error)
• type Check
  • func (r Check) RawJSON() string
  • func (r *Check) UnmarshalJSON(data []byte) error
• type CheckListParams
  • func (r CheckListParams) URLQuery() (v url.Values, err error)
• type CheckListResponse
  • func (r CheckListResponse) RawJSON() string
  • func (r *CheckListResponse) UnmarshalJSON(data []byte) error
• type CheckNewParams
  • func (r CheckNewParams) MarshalJSON() (data []byte, err error)
  • func (r *CheckNewParams) UnmarshalJSON(data []byte) error
• type CheckService
  • func NewCheckService(opts ...option.RequestOption) (r CheckService)
  • func (r *CheckService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error)
  • func (r *CheckService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Check, err error)
  • func (r *CheckService) List(ctx context.Context, query CheckListParams, opts ...option.RequestOption) (res *CheckListResponse, err error)
  • func (r *CheckService) New(ctx context.Context, body CheckNewParams, opts ...option.RequestOption) (res *Check, err error)
  • func (r *CheckService) Update(ctx context.Context, id string, body CheckUpdateParams, ...) (res *Check, err error)
• type CheckUpdateParams
  • func (r CheckUpdateParams) MarshalJSON() (data []byte, err error)
  • func (r *CheckUpdateParams) UnmarshalJSON(data []byte) error
• type Client
  • func NewClient(opts ...option.RequestOption) (r Client)
  • func (r *Client) Delete(ctx context.Context, path string, params any, res any, ...) error
  • func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, ...) error
  • func (r *Client) Get(ctx context.Context, path string, params any, res any, ...) error
  • func (r *Client) Patch(ctx context.Context, path string, params any, res any, ...) error
  • func (r *Client) Post(ctx context.Context, path string, params any, res any, ...) error
  • func (r *Client) Put(ctx context.Context, path string, params any, res any, ...) error
• type Error
• type HealthzCheckResponse
  • func (r HealthzCheckResponse) RawJSON() string
  • func (r *HealthzCheckResponse) UnmarshalJSON(data []byte) error
• type HealthzService
  • func NewHealthzService(opts ...option.RequestOption) (r HealthzService)
  • func (r *HealthzService) Check(ctx context.Context, opts ...option.RequestOption) (res *HealthzCheckResponse, err error)

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 (SIMPLECHECKS_API_KEY, SIMPLECHECKS_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 AccountGetResponse

type AccountGetResponse struct {
	// Cached run-credit balance, in run-credit units.
	Balance   int64     `json:"balance" api:"required"`
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	Name      string    `json:"name" api:"required"`
	// True when execution is paused (e.g. balance exhausted).
	Paused bool `json:"paused" api:"required"`
	// Billing plan identifier.
	Plan string `json:"plan" api:"required"`
	// Renameable URL-friendly handle. Display only — never use as a system identifier.
	Slug string `json:"slug" api:"required"`
	// Stable account identifier (`acct_<typeid>`). Used in API responses and audit
	// logs.
	Typeid string `json:"typeid" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Balance     respjson.Field
		CreatedAt   respjson.Field
		Name        respjson.Field
		Paused      respjson.Field
		Plan        respjson.Field
		Slug        respjson.Field
		Typeid      respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

Account profile + cached billing balance. Returned by GET /v1/account.

func (AccountGetResponse) RawJSON

func (r AccountGetResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*AccountGetResponse) UnmarshalJSON

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

type AccountService

type AccountService struct {
	// contains filtered or unexported fields
}

Account profile and balance.

AccountService contains methods and other services that help with interacting with the simplechecks 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 NewAccountService method instead.

func NewAccountService

func NewAccountService(opts ...option.RequestOption) (r AccountService)

NewAccountService 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 (*AccountService) Get

func (r *AccountService) Get(ctx context.Context, opts ...option.RequestOption) (res *AccountGetResponse, err error)

Returns the account row stitched together with the cached billing balance and the `paused` flag, so a single dashboard read fetches everything the customer's home page needs. Requires the `account:read` scope.

type Check

type Check struct {
	ID string `json:"id" api:"required"`
	// Owning account's `acct_<typeid>`. Read-only.
	AccountTypeid string    `json:"account_typeid" api:"required"`
	CreatedAt     time.Time `json:"created_at" api:"required" format:"date-time"`
	Enabled       bool      `json:"enabled" api:"required"`
	// Garrison the check is bound to. Server-assigned.
	GarrisonID string `json:"garrison_id" api:"required"`
	Name       string `json:"name" api:"required"`
	// Cron expression; minute granularity.
	Schedule  string `json:"schedule" api:"required"`
	TargetURL string `json:"target_url" api:"required" format:"uri"`
	TimeoutMs int64  `json:"timeout_ms" api:"required"`
	// Check type. Currently only `http` is publicly documented.
	Type      string    `json:"type" api:"required"`
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// Optional artifact reference (e.g. uploaded Playwright bundle).
	ArtifactURL string `json:"artifact_url"`
	// Per-check-type configuration blob. Opaque on the wire.
	Config map[string]any `json:"config"`
	// Region/location on read responses is empty; populated on create requests only.
	Location string `json:"location"`
	// Cloud provider on read responses is empty; populated on create requests only.
	Provider string `json:"provider"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID            respjson.Field
		AccountTypeid respjson.Field
		CreatedAt     respjson.Field
		Enabled       respjson.Field
		GarrisonID    respjson.Field
		Name          respjson.Field
		Schedule      respjson.Field
		TargetURL     respjson.Field
		TimeoutMs     respjson.Field
		Type          respjson.Field
		UpdatedAt     respjson.Field
		ArtifactURL   respjson.Field
		Config        respjson.Field
		Location      respjson.Field
		Provider      respjson.Field
		ExtraFields   map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (Check) RawJSON

func (r Check) RawJSON() string

Returns the unmodified JSON received from the API

func (*Check) UnmarshalJSON

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

type CheckListParams

type CheckListParams struct {
	// Max number of checks to return. Defaults to 100; the server caps further.
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// Number of checks to skip. Pass the `next_offset` from the previous page.
	Offset param.Opt[int64] `query:"offset,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (CheckListParams) URLQuery

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

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

type CheckListResponse

type CheckListResponse struct {
	Checks []Check `json:"checks" api:"required"`
	// Offset to pass on the next request to continue pagination. Zero (or absent) when
	// there's no more data.
	NextOffset int64 `json:"next_offset"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Checks      respjson.Field
		NextOffset  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (CheckListResponse) RawJSON

func (r CheckListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*CheckListResponse) UnmarshalJSON

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

type CheckNewParams

type CheckNewParams struct {
	Enabled bool `json:"enabled" api:"required"`
	// Provider-specific region/location.
	Location string `json:"location" api:"required"`
	Name     string `json:"name" api:"required"`
	// Cloud provider (`mock`, `ec2`, `ovh`, `azure`, `gcp`, `hetzner`).
	Provider    string            `json:"provider" api:"required"`
	Schedule    string            `json:"schedule" api:"required"`
	TargetURL   string            `json:"target_url" api:"required" format:"uri"`
	Type        string            `json:"type" api:"required"`
	ArtifactURL param.Opt[string] `json:"artifact_url,omitzero"`
	TimeoutMs   param.Opt[int64]  `json:"timeout_ms,omitzero"`
	Config      map[string]any    `json:"config,omitzero"`
	// contains filtered or unexported fields
}

func (CheckNewParams) MarshalJSON

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

func (*CheckNewParams) UnmarshalJSON

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

type CheckService

type CheckService struct {
	// contains filtered or unexported fields
}

CRUD for synthetic-monitoring checks.

CheckService contains methods and other services that help with interacting with the simplechecks 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 NewCheckService method instead.

func NewCheckService

func NewCheckService(opts ...option.RequestOption) (r CheckService)

NewCheckService 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 (*CheckService) Delete

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

Disables the check. Requires the `checks:write` scope.

func (*CheckService) Get

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

Returns the check with the given id. 404 if no such check exists for the calling account. Requires the `checks:read` scope.

func (*CheckService) List

func (r *CheckService) List(ctx context.Context, query CheckListParams, opts ...option.RequestOption) (res *CheckListResponse, err error)

Returns the caller's checks with simple offset pagination. `next_offset` is set when a full page was returned and zero when there's no more data. Requires the `checks:read` scope.

func (*CheckService) New

func (r *CheckService) New(ctx context.Context, body CheckNewParams, opts ...option.RequestOption) (res *Check, err error)

Creates a check bound to the resolved garrison for the given `provider` + `location`. Requires the `checks:write` scope.

func (*CheckService) Update

func (r *CheckService) Update(ctx context.Context, id string, body CheckUpdateParams, opts ...option.RequestOption) (res *Check, err error)

All fields in the body are optional; omitted fields are left unchanged. Requires the `checks:write` scope.

type CheckUpdateParams

type CheckUpdateParams struct {
	ArtifactURL param.Opt[string] `json:"artifact_url,omitzero"`
	Enabled     param.Opt[bool]   `json:"enabled,omitzero"`
	Name        param.Opt[string] `json:"name,omitzero"`
	Schedule    param.Opt[string] `json:"schedule,omitzero"`
	TargetURL   param.Opt[string] `json:"target_url,omitzero" format:"uri"`
	TimeoutMs   param.Opt[int64]  `json:"timeout_ms,omitzero"`
	Type        param.Opt[string] `json:"type,omitzero"`
	Config      map[string]any    `json:"config,omitzero"`
	// contains filtered or unexported fields
}

func (CheckUpdateParams) MarshalJSON

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

func (*CheckUpdateParams) UnmarshalJSON

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

type Client

type Client struct {

	// Liveness + readiness.
	Healthz HealthzService
	// Account profile and balance.
	Account AccountService
	// CRUD for synthetic-monitoring checks.
	Checks CheckService
	// contains filtered or unexported fields
}

Client creates a struct with services and top level methods that help with interacting with the simplechecks 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 (SIMPLECHECKS_API_KEY, SIMPLECHECKS_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 HealthzCheckResponse

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

func (HealthzCheckResponse) RawJSON

func (r HealthzCheckResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*HealthzCheckResponse) UnmarshalJSON

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

type HealthzService

type HealthzService struct {
	// contains filtered or unexported fields
}

Liveness + readiness.

HealthzService contains methods and other services that help with interacting with the simplechecks 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 NewHealthzService method instead.

func NewHealthzService

func NewHealthzService(opts ...option.RequestOption) (r HealthzService)

NewHealthzService 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 (*HealthzService) Check

func (r *HealthzService) Check(ctx context.Context, opts ...option.RequestOption) (res *HealthzCheckResponse, err error)

Returns 200 when the process is up. webapp/api is stateless, so "the process is up" is the entire health story; Kubernetes uses this for both liveness and readiness probes. Public — no auth.