-
Notifications
You must be signed in to change notification settings - Fork 32
/
doc.go
44 lines (44 loc) · 982 Bytes
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
// 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)
// }
//
// v := url.Values{}
// v.Set("tags", "test1,test2")
// testsWithFilter, err := c.Tests().AllWithFilter(v)
// 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, err := c.Tests().Update(t)
// if err != nil {
// log.Fatal(err)
// }
// fmt.Printf("New Test created with id: %d\n", t2.TestID)
//
// // get Tests details
// t, err := tt.Detail(id)
// ...
package statuscake