terraform/vendor/github.com/DreamItGetIT/statuscake/doc.go

35 lines
770 B
Go

// Package statuscake implements a client for statuscake.com API.
//
// // list all `Tests`
// c, err := statuscake.New(statuscake.Auth{Username: username, Apikey: apikey})
// if err != nil {
// log.Fatal(err)
// }
//
// tests, err := c.Tests().All()
// if err != nil {
// log.Fatal(err)
// }
//
// // delete a `Test`
// err = c.Tests().Delete(TestID)
//
// // create a test
// t := &statuscake.Test{
// WebsiteName: "Foo",
// WebsiteURL: "htto://example.com",
// ... other required args...
// }
//
// if err = t.Validate(); err != nil {
// log.Fatal(err)
// }
//
// t2 := c.Tests().Update(t)
// fmt.Printf("New Test created with id: %d\n", t2.TestID)
//
// // get Tests details
// t, err := tt.Detail(id)
// ...
package statuscake