]> git.immae.eu Git - github/fretlink/terraform-provider-statuscake.git/blame - vendor/github.com/DreamItGetIT/statuscake/doc.go
Merge pull request #35 from ivanschwarz/feat/ssl-validation-2
[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//
24c95871
IS
14// v := url.Values{}
15// v.Set("tags", "test1,test2")
16// testsWithFilter, err := c.Tests().AllWithFilter(v)
17// if err != nil {
18// log.Fatal(err)
19// }
20//
9b12e4fe
JC
21// // delete a `Test`
22// err = c.Tests().Delete(TestID)
23//
24// // create a test
25// t := &statuscake.Test{
26// WebsiteName: "Foo",
27// WebsiteURL: "htto://example.com",
28// ... other required args...
29// }
30//
31// if err = t.Validate(); err != nil {
32// log.Fatal(err)
33// }
34//
24c95871
IS
35// t2, err := c.Tests().Update(t)
36// if err != nil {
37// log.Fatal(err)
38// }
9b12e4fe
JC
39// fmt.Printf("New Test created with id: %d\n", t2.TestID)
40//
41// // get Tests details
42// t, err := tt.Detail(id)
43// ...
44package statuscake