Merge pull request #5 from STLVRTX/master

fix uptimemonitor field, update readme
iLert · Jul 4, 2022 · a3f9e52 · a3f9e52
2 parents 6c340c5 + acbc7db
commit a3f9e52
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -2,14 +2,19 @@
 
 **The official iLert Go api bindings.**
 
+## Legacy API
+
+> If you want to use the old client with v1 resources, please install it with the following command: `go get github.com/iLert/ilert-go`
+
+
 ## Create an incident (manually)
 
 ```go
 package main
 
 import (
 	"log"
-	"github.com/iLert/ilert-go"
+	"github.com/iLert/ilert-go/v2"
 )
 
 func main() {
@@ -21,8 +26,8 @@ func main() {
 	event := &ilert.Event{
 		APIKey:      apiKey,
 		EventType:   ilert.EventTypes.Alert,
-		Summary:     "My test incident summary",
-		IncidentKey: "123456",
+		Summary:     "My test alert summary",
+		AlertKey: "123456",
 	}
 
 	input := &ilert.CreateEventInput{Event: event}
@@ -32,7 +37,7 @@ func main() {
 		log.Fatalln("ERROR:", err)
 	}
 
-	log.Println("Incident key:", result.EventResponse.IncidentKey)
+	log.Println("Event processed!")
 }
 ```
 
@@ -43,7 +48,7 @@ package main
 
 import (
 	"log"
-	"github.com/iLert/ilert-go"
+	"github.com/iLert/ilert-go/v2"
 )
 
 func main() {
@@ -72,7 +77,7 @@ package main
 
 import (
 	"log"
-	"github.com/iLert/ilert-go"
+	"github.com/iLert/ilert-go/v2"
 )
 
 func main() {

diff --git a/event.go b/event.go
@@ -84,7 +84,7 @@ func (c *Client) CreateEvent(input *CreateEventInput) (*CreateEventOutput, error
 	if err != nil {
 		return nil, err
 	}
-	if apiErr := getGenericAPIError(resp, 200); apiErr != nil {
+	if apiErr := getGenericAPIError(resp, 200, 202); apiErr != nil {
 		return nil, apiErr
 	}
 	eventResponse := &EventResponse{}

diff --git a/examples/event/main.go b/examples/event/main.go
@@ -33,5 +33,5 @@ func main() {
 		}
 	}
 
-	log.Println("Incident key:", result.EventResponse.AlertKey)
+	log.Println("Alert key:", result.EventResponse.AlertKey)
 }
diff --git a/uptimemonitor.go b/uptimemonitor.go
@@ -8,21 +8,21 @@ import (
 
 // UptimeMonitor definition https://api.ilert.com/api-docs/#tag/Uptime-Monitors
 type UptimeMonitor struct {
-	ID                              int64                     `json:"id,omitempty"`
-	Name                            string                    `json:"name"`
-	Region                          string                    `json:"region"`
-	CheckType                       string                    `json:"checkType"`
-	CheckParams                     *UptimeMonitorCheckParams `json:"checkParams,omitempty"`
-	IntervalSec                     int                       `json:"intervalSec,omitempty"`                     // default: 300
-	TimeoutMs                       int                       `json:"timeoutMs,omitempty"`                       // default: 30000
-	CreateIncidentAfterFailedChecks int                       `json:"createIncidentAfterFailedChecks,omitempty"` // @deprecated
-	CreateAlertAfterFailedChecks    int                       `json:"createAlertAfterFailedChecks,omitempty"`    // default: 1
-	EscalationPolicy                *EscalationPolicy         `json:"escalationPolicy,omitempty"`
-	Paused                          bool                      `json:"paused,omitempty"`   // default: false
-	EmbedURL                        string                    `json:"embedURL,omitempty"` // read only
-	ShareURL                        string                    `json:"shareURL,omitempty"` // read only
-	Status                          string                    `json:"status,omitempty"`
-	LastStatusChange                string                    `json:"lastStatusChange,omitempty"` // Date time string in ISO format
+	ID                              int64                    `json:"id,omitempty"`
+	Name                            string                   `json:"name"`
+	Region                          string                   `json:"region"`
+	CheckType                       string                   `json:"checkType"`
+	CheckParams                     UptimeMonitorCheckParams `json:"checkParams"`
+	IntervalSec                     int                      `json:"intervalSec,omitempty"`                     // default: 300
+	TimeoutMs                       int                      `json:"timeoutMs,omitempty"`                       // default: 30000
+	CreateIncidentAfterFailedChecks int                      `json:"createIncidentAfterFailedChecks,omitempty"` // @deprecated
+	CreateAlertAfterFailedChecks    int                      `json:"createAlertAfterFailedChecks,omitempty"`    // default: 1
+	EscalationPolicy                *EscalationPolicy        `json:"escalationPolicy,omitempty"`
+	Paused                          bool                     `json:"paused,omitempty"`   // default: false
+	EmbedURL                        string                   `json:"embedURL,omitempty"` // read only
+	ShareURL                        string                   `json:"shareURL,omitempty"` // read only
+	Status                          string                   `json:"status,omitempty"`
+	LastStatusChange                string                   `json:"lastStatusChange,omitempty"` // Date time string in ISO format
 }
 
 // UptimeMonitorCheckParams definition
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,5 +33,5 @@ func main() { @@
     		}
     	}
-    	log.Println("Incident key:", result.EventResponse.AlertKey)
+    	log.Println("Alert key:", result.EventResponse.AlertKey)
     }