]> git.immae.eu Git - github/fretlink/terraform-provider-statuscake.git/blame - vendor/github.com/DreamItGetIT/statuscake/doc.go
merge changes from https://github.com/DreamItGetIT/statuscake/pull/24 to vendor directory
[github/fretlink/terraform-provider-statuscake.git] / vendor / github.com / DreamItGetIT / statuscake / doc.go
CommitLineData
9b12e4fe
JC
1// Package statuscake implements a client for statuscake.com API.
2//
3// // list all `Tests`
4// c, err := statuscake.New(statuscake.Auth{Username: username, Apikey: apikey})
5// if err != nil {
6// log.Fatal(err)
7// }
8//
9// tests, err := c.Tests().All()
10// if err != nil {
11// log.Fatal(err)
12// }
13//
14// // delete a `Test`
15// err = c.Tests().Delete(TestID)
16//
17// // create a test
18// t := &statuscake.Test{
19// WebsiteName: "Foo",
20// WebsiteURL: "htto://example.com",
21// ... other required args...
22// }
23//
24// if err = t.Validate(); err != nil {
25// log.Fatal(err)
26// }
27//
28// t2 := c.Tests().Update(t)
29// fmt.Printf("New Test created with id: %d\n", t2.TestID)
30//
31// // get Tests details
32// t, err := tt.Detail(id)
33// ...
34package statuscake