healthchecks

type Channel struct {
	ID   *string `json:"id"`
	Name *string `json:"name"`
	Kind *string `json:"kind"`
	// contains filtered or unexported fields
}

type Check struct {
	// Name is the check's name.
	Name *string `json:"name,omitempty"`

	// Tags is the check's tags.
	Tags *Strings `json:"tags,omitempty"`

	// Description is the check's description.
	Description *string `json:"desc,omitempty"`

	// TimeoutPeriod is the check's configured period for timeout. Not to be
	// confused with GracePeriod.
	TimeoutPeriod *Duration `json:"timeout,omitempty"`

	// GracePeriod is the check's configured period for grace time after timing
	// out. Not to be confused with TimeoutPeriod.
	GracePeriod *Duration `json:"grace,omitempty"`

	// Methods is the check's list of allowed methods.
	// According to Healthchecks' API reference, it only supports:
	//   * HEAD, GET, POST, PUT; or
	//   * POST, exclusively.
	// It does not support a free combination of the above.
	// It is recommended to use CheckMethodsAll and CheckMethodsPost when
	// instantiating Check, for better code readability.
	Methods *Strings `json:"methods,omitempty"`

	// ManualResume is the check's setting for resuming when the check is in
	// paused status. If the check is paused, there are two options:
	//   * (false) leave the paused status (resume) after first ping; or
	//   * (true) continue in paused status regardless of pings.
	// It is recommended to use CheckManualResumeTrue and CheckManualResumeFalse
	// when instantiating Check, for better code readability.
	ManualResume *bool `json:"manual_resume,omitempty"`

	// Channels is the check's configured notification integrations.
	Channels *Strings  `json:"channels,omitempty"`
	Unique   *[]string `json:"unique,omitempty"`

	// Status is the check's status, as reported by Healthchecks' API.
	// It is recommended to use the following when evaluating Status:
	//   * CheckStatusUp: the check is in UP status;
	//   * CheckStatusDown: the check is in DOWN status;
	//   * CheckStatusStarted: the check has started;
	//   * CheckStatusPaused: the check is paused;
	//   * CheckStatusNew: the check was never pinged, ever;
	//
	// This field is read-only, and should not be used when instantiating Check
	// for write operations within the Healthchecks API.
	Status *string `json:"status,omitempty"`

	// LastPing references the time at which the check was last pinged, as
	// reported by Healthchecks' API.
	//
	// This field is read-only, and should not be used when instantiating Check
	// for write operations within the Healthchecks API.
	LastPing *time.Time `json:"last_ping,omitempty"`

	// NextPing represents the time at which the check's next ping should come,
	// as reported by Healthchecks' API.
	// It is supposed to be the result of adding TimeoutPeriod to LastPing.
	//
	// This field is read-only, and should not be used when instantiating Check
	// for write operations within the Healthchecks API.
	NextPing *time.Time `json:"next_ping,omitempty"`

	// PingCount is the number of times the check was pinged since its creation,
	// as reported by Healthchecks' API.
	// This package represents PingCount as an uint64, thus setting the max
	// number of pings to 18446744073709551615 before overflowing. Healthchecks'
	// API internal representation of this number is undisclosed, but it may be
	// well below (or above) that ceiling.
	//
	// This field is read-only, and should not be used when instantiating Check
	// for write operations within the Healthchecks API.
	PingCount *uint64 `json:"n_pings,omitempty"`

	// PingURL is the URL used for Healthchecks' pinging API, as reported by
	// Healthchecks' API itself.
	//
	// This field is read-only, and should not be used when instantiating Check
	// for write operations within the Healthchecks API.
	PingURL *URL `json:"ping_url,omitempty"`

	// UpdateURL is the URL used for Healthchecks' management API, for updating
	// the check's settings, as reported by Healthchecks' API itself.
	//
	// This field is read-only, and should not be used when instantiating Check
	// for write operations within the Healthchecks API.
	UpdateURL *URL `json:"update_url,omitempty"`

	// PauseURL is the URL used for Healthchecks' management API, for pausing
	// the check, as reported by Healthchecks' API itself.
	//
	// This field is read-only, and should not be used when instantiating Check
	// for write operations within the Healthchecks API.
	PauseURL *URL `json:"pause_url,omitempty"`
	// contains filtered or unexported fields
}

type CheckFlip struct {
	// Timestamp represents the time at which the status flipped for the check.
	Timestamp *time.Time `json:"timestamp"`

	// Up represents the status which the check switched into when it flipped.
	Up *int `json:"up"`
}

type CheckPing struct {
	// Type is the type of ping, as reported by Healthchecks' API itself.
	Type *string `json:"type"`

	// Date references the time at which the check was pinged, as reported by
	// Healthchecks' API itself.
	Date *time.Time `json:"date"`

	// N is the value of PingCount after this ping happened, as reported by
	// Healthchecks' API itself.
	N *int `json:"n"`

	// Scheme is the scheme over which the ping was performed, as reported by
	// Healthchecks' API itself.
	Scheme *string `json:"scheme"`

	// RemoteAddr is the IP address from which the check was pinged, as reported
	// by Healthchecks' API itself.
	RemoteAddr *IP `json:"remote_addr"`

	// Method is the HTTP method used for pinging, as reported by Healthchecks'
	// API itself.
	Method *string `json:"method"`

	// UserAgent is the ping's HTTP request User-Agent header, as reported by
	// Healthchecks' API itself.
	UserAgent *string `json:"ua"`

	// Duration is the duration of the ping, since its start until its first
	// status report, as reported by Healthchecks' API itself.
	Duration *Duration `json:"duration"`
}

type Duration time.Duration

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

type IP net.IP

type Strings []string

type URL url.URL