simplechecksgo

package module

Go to main page

Versions in this module

v0

v0.2.0

May 10, 2026

Changes in this version

type Client

+ Incidents *IncidentService

+ type Incident struct

+ CheckID string

+ CheckName string

+ ID string

+ JSON incidentJSON

+ ResolvedAtUnixMs int64

+ StartedAtUnixMs int64

+ Status IncidentStatus

+ func (r *Incident) UnmarshalJSON(data []byte) (err error)

+ type IncidentListParams struct

+ Limit param.Field[int64]

+ Offset param.Field[int64]

+ func (r IncidentListParams) URLQuery() (v url.Values)

+ type IncidentListResponse struct

+ Incidents []Incident

+ JSON incidentListResponseJSON

+ NextOffset int64

+ func (r *IncidentListResponse) UnmarshalJSON(data []byte) (err error)

+ type IncidentService struct

+ Options []option.RequestOption

+ func NewIncidentService(opts ...option.RequestOption) (r *IncidentService)

+ func (r *IncidentService) List(ctx context.Context, query IncidentListParams, opts ...option.RequestOption) (res *IncidentListResponse, err error)

+ type IncidentStatus string

+ const IncidentStatusOngoing

+ const IncidentStatusResolved

+ func (r IncidentStatus) IsKnown() bool

v0.1.0

May 10, 2026

Changes in this version

+ func F[T any](value T) param.Field[T]

+ func FileParam(reader io.Reader, filename string, contentType string) param.Field[io.Reader]

+ func Null[T any]() param.Field[T]

+ func Raw[T any](value any) param.Field[T]

+ type APIKey struct

+ AccountTypeid string

+ CreatedAt time.Time

+ ID string

+ JSON apiKeyJSON

+ LastUsedAt time.Time

+ Name string

+ Prefix string

+ RevokedAt time.Time

+ Scopes []string

+ func (r *APIKey) UnmarshalJSON(data []byte) (err error)

+ type Account struct

+ Balance int64

+ CreatedAt time.Time

+ JSON accountJSON

+ Name string

+ Paused bool

+ Plan string

+ Slug string

+ Typeid string

+ func (r *Account) UnmarshalJSON(data []byte) (err error)

type AccountService

+ Options []option.RequestOption

+ type Aggregate struct

+ AccountID string

+ BucketEndUnixMs int64

+ BucketStartUnixMs int64

+ CheckID string

+ DurationAvgMs int64

+ DurationMaxMs int64

+ DurationMinMs int64

+ ErrorCount int64

+ FailCount int64

+ JSON aggregateJSON

+ Location string

+ PassCount int64

+ TimeoutCount int64

+ TotalCount int64

+ func (r *Aggregate) UnmarshalJSON(data []byte) (err error)

+ type AlertChannel struct

+ Config map[string]interface{}

+ JSON alertChannelJSON

+ Target string

+ Type AlertChannelType

+ func (r *AlertChannel) UnmarshalJSON(data []byte) (err error)

+ type AlertChannelParam struct

+ Config param.Field[map[string]interface{}]

+ Target param.Field[string]

+ Type param.Field[AlertChannelType]

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

+ type AlertChannelType string

+ const AlertChannelTypeDiscord

+ const AlertChannelTypeEmail

+ const AlertChannelTypeOpsgenie

+ const AlertChannelTypePagerduty

+ const AlertChannelTypeSlack

+ const AlertChannelTypeTeams

+ const AlertChannelTypeWebhook

+ func (r AlertChannelType) IsKnown() bool

+ type AlertConfig struct

+ AccountID string

+ Channels []AlertChannel

+ CheckID string

+ ConsecutiveFailuresThreshold int64

+ ConsensusM int64

+ ConsensusN int64

+ CreatedAt time.Time

+ Enabled bool

+ JSON alertConfigJSON

+ MaintenanceWindows []MaintenanceWindow

+ UpdatedAt time.Time

+ func (r *AlertConfig) UnmarshalJSON(data []byte) (err error)

+ type AlertConfigParam struct

+ AccountID param.Field[string]

+ Channels param.Field[[]AlertChannelParam]

+ CheckID param.Field[string]

+ ConsecutiveFailuresThreshold param.Field[int64]

+ ConsensusM param.Field[int64]

+ ConsensusN param.Field[int64]

+ Enabled param.Field[bool]

+ MaintenanceWindows param.Field[[]MaintenanceWindowParam]

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

+ type Balance struct

+ Balance int64

+ JSON balanceJSON

+ Paused bool

+ func (r *Balance) UnmarshalJSON(data []byte) (err error)

+ type BalanceService struct

+ Options []option.RequestOption

+ func NewBalanceService(opts ...option.RequestOption) (r *BalanceService)

+ func (r *BalanceService) Get(ctx context.Context, opts ...option.RequestOption) (res *Balance, err error)

+ type CheckAlertReplaceParams struct

+ AlertConfig AlertConfigParam

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

+ type CheckAlertService struct

+ Options []option.RequestOption

+ func NewCheckAlertService(opts ...option.RequestOption) (r *CheckAlertService)

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

+ func (r *CheckAlertService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *AlertConfig, err error)

+ func (r *CheckAlertService) Replace(ctx context.Context, id string, body CheckAlertReplaceParams, ...) (res *AlertConfig, err error)

+ func (r *CheckAlertService) TestFire(ctx context.Context, id string, opts ...option.RequestOption) (res *CheckAlertTestFireResponse, err error)

+ type CheckAlertTestFireResponse struct

+ ChannelCount int64

+ Enqueued int64

+ IncidentID string

+ JSON checkAlertTestFireResponseJSON

+ func (r *CheckAlertTestFireResponse) UnmarshalJSON(data []byte) (err error)

type CheckService

+ Alerts *CheckAlertService

+ Options []option.RequestOption

+ func (r *CheckService) ListAutoPaging(ctx context.Context, query CheckListParams, opts ...option.RequestOption) *pagination.OffsetAutoPager[Check]

+ type CheckoutSession struct

+ CheckoutURL string

+ ExpiresAt time.Time

+ JSON checkoutSessionJSON

+ StripeSessionID string

+ func (r *CheckoutSession) UnmarshalJSON(data []byte) (err error)

+ type CheckoutSessionNewParams struct

+ BundleSKU param.Field[CheckoutSessionNewParamsBundleSKU]

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

+ type CheckoutSessionNewParamsBundleSKU string

+ const CheckoutSessionNewParamsBundleSKUGrowth

+ const CheckoutSessionNewParamsBundleSKUScale

+ const CheckoutSessionNewParamsBundleSKUStarter

+ const CheckoutSessionNewParamsBundleSKUTeam

+ func (r CheckoutSessionNewParamsBundleSKU) IsKnown() bool

+ type CheckoutSessionService struct

+ Options []option.RequestOption

+ func NewCheckoutSessionService(opts ...option.RequestOption) (r *CheckoutSessionService)

+ func (r *CheckoutSessionService) New(ctx context.Context, body CheckoutSessionNewParams, ...) (res *CheckoutSession, err error)

type Client

+ Balance *BalanceService

+ CheckoutSessions *CheckoutSessionService

+ Keys *KeyService

+ Options []option.RequestOption

+ Runs *RunService

+ type KeyListResponse struct

+ JSON keyListResponseJSON

+ Keys []APIKey

+ func (r *KeyListResponse) UnmarshalJSON(data []byte) (err error)

+ type KeyNewParams struct

+ Name param.Field[string]

+ Scopes param.Field[[]string]

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

+ type KeyNewResponse struct

+ JSON keyNewResponseJSON

+ KeyID string

+ PlaintextToken string

+ Prefix string

+ func (r *KeyNewResponse) UnmarshalJSON(data []byte) (err error)

+ type KeyService struct

+ Options []option.RequestOption

+ func NewKeyService(opts ...option.RequestOption) (r *KeyService)

+ func (r *KeyService) List(ctx context.Context, opts ...option.RequestOption) (res *KeyListResponse, err error)

+ func (r *KeyService) New(ctx context.Context, body KeyNewParams, opts ...option.RequestOption) (res *KeyNewResponse, err error)

+ func (r *KeyService) Revoke(ctx context.Context, id string, opts ...option.RequestOption) (err error)

+ type MaintenanceWindow struct

+ EndUnixMs int64

+ JSON maintenanceWindowJSON

+ StartUnixMs int64

+ func (r *MaintenanceWindow) UnmarshalJSON(data []byte) (err error)

+ type MaintenanceWindowParam struct

+ EndUnixMs param.Field[int64]

+ StartUnixMs param.Field[int64]

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

+ type Run struct

+ CheckID string

+ CheckName string

+ DurationMs int64

+ ErrorMessage string

+ GarrisonID string

+ ID string

+ InstanceID string

+ JSON runJSON

+ Metadata string

+ NodeName string

+ StartedAtUnixMs int64

+ Status RunStatus

+ Type string

+ func (r *Run) UnmarshalJSON(data []byte) (err error)

+ type RunAggregatesParams struct

+ Bucket param.Field[RunAggregatesParamsBucket]

+ CheckID param.Field[string]

+ From param.Field[int64]

+ Limit param.Field[int64]

+ Location param.Field[string]

+ To param.Field[int64]

+ func (r RunAggregatesParams) URLQuery() (v url.Values)

+ type RunAggregatesParamsBucket string

+ const RunAggregatesParamsBucketMinute

+ func (r RunAggregatesParamsBucket) IsKnown() bool

+ type RunAggregatesResponse struct

+ Aggregates []Aggregate

+ JSON runAggregatesResponseJSON

+ func (r *RunAggregatesResponse) UnmarshalJSON(data []byte) (err error)

+ type RunListParams struct

+ CheckID param.Field[string]

+ Limit param.Field[int64]

+ Offset param.Field[int64]

+ Since param.Field[int64]

+ Status param.Field[RunListParamsStatus]

+ func (r RunListParams) URLQuery() (v url.Values)

+ type RunListParamsStatus string

+ const RunListParamsStatusError

+ const RunListParamsStatusFail

+ const RunListParamsStatusPass

+ const RunListParamsStatusTimeout

+ func (r RunListParamsStatus) IsKnown() bool

+ type RunListResponse struct

+ JSON runListResponseJSON

+ Runs []Run

+ func (r *RunListResponse) UnmarshalJSON(data []byte) (err error)

+ type RunService struct

+ Options []option.RequestOption

+ func NewRunService(opts ...option.RequestOption) (r *RunService)

+ func (r *RunService) Aggregates(ctx context.Context, query RunAggregatesParams, opts ...option.RequestOption) (res *RunAggregatesResponse, err error)

+ func (r *RunService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *Run, err error)

+ func (r *RunService) List(ctx context.Context, query RunListParams, opts ...option.RequestOption) (res *RunListResponse, err error)

+ func (r *RunService) LogsStreaming(ctx context.Context, id string, opts ...option.RequestOption) (stream *jsonl.Stream[io.Reader])

+ type RunStatus string

+ const RunStatusError

+ const RunStatusFail

+ const RunStatusPass

+ const RunStatusTimeout

+ func (r RunStatus) IsKnown() bool

v0.0.2

Apr 29, 2026

Changes in this version

+ 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 struct

+ Balance int64

+ CreatedAt time.Time

+ JSON struct{ ... }

+ Name string

+ Paused bool

+ Plan string

+ Slug string

+ Typeid string

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

+ func (r AccountGetResponse) RawJSON() string

+ type AccountService struct

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

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

+ type Check struct

+ AccountTypeid string

+ ArtifactURL string

+ Config map[string]any

+ CreatedAt time.Time

+ Enabled bool

+ GarrisonID string

+ ID string

+ JSON struct{ ... }

+ Location string

+ Name string

+ Provider string

+ Schedule string

+ TargetURL string

+ TimeoutMs int64

+ Type string

+ UpdatedAt time.Time

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

+ func (r Check) RawJSON() string

+ type CheckListParams struct

+ Limit param.Opt[int64]

+ Offset param.Opt[int64]

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

+ type CheckListResponse struct

+ Checks []Check

+ JSON struct{ ... }

+ NextOffset int64

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

+ func (r CheckListResponse) RawJSON() string

+ type CheckNewParams struct

+ ArtifactURL param.Opt[string]

+ Config map[string]any

+ Enabled bool

+ Location string

+ Name string

+ Provider string

+ Schedule string

+ TargetURL string

+ TimeoutMs param.Opt[int64]

+ Type string

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

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

+ type CheckService struct

+ 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 struct

+ ArtifactURL param.Opt[string]

+ Config map[string]any

+ Enabled param.Opt[bool]

+ Name param.Opt[string]

+ Schedule param.Opt[string]

+ TargetURL param.Opt[string]

+ TimeoutMs param.Opt[int64]

+ Type param.Opt[string]

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

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

+ type Client struct

+ Account AccountService

+ Checks CheckService

+ Healthz HealthzService

+ 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 = apierror.Error

+ type HealthzCheckResponse struct

+ JSON struct{ ... }

+ Status string

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

+ func (r HealthzCheckResponse) RawJSON() string

+ type HealthzService struct

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

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL