Add new endpoint to update conversation webhooks

* ENG-129

Adding new UpdateWebhook for conversations

- includes a new struct for the updateRequest
- adding test to make sure it works

* ENG-129

Adding status to webhook
Adding new property to the WebhookUpdateRequest so customers can enabled/disable webhooks

* ENG-129

Fix spelling mistake in ReadMe

* ENG-129

Omiting empty properties if the user is only updating certain fields.

Updating the comment against the new endpoint to reflect this information

* Update comments

Fix typo and add full stops at the end of the sentence

* bump version

Author: jen-obyrne

README.md

@@ -70,7 +70,7 @@ Complete documentation, instructions, and examples are available at:
 
 Upgrading
 ---------
-If you're upgrading from older versions, please read the [Messagebird `go-rest-api` uprading guide](UPGRADING.md).
+If you're upgrading from older versions, please read the [Messagebird `go-rest-api` upgrading guide](UPGRADING.md).
 
 License
 -------

client.go

@@ -25,7 +25,7 @@ import (
 
 const (
 	// ClientVersion is used in User-Agent request header to provide server with API level.
-	ClientVersion = "5.1.1"
+	ClientVersion = "5.3.0"
 
 	// Endpoint points you to MessageBird REST API.
 	Endpoint = "https://rest.messagebird.com"

conversation/api.go

@@ -189,6 +189,7 @@ type Webhook struct {
 	ChannelID       string
 	Events          []WebhookEvent
 	URL             string
+	Status          WebhookStatus
 	CreatedDatetime *time.Time
 	UpdatedDatetime *time.Time
 }
@@ -202,6 +203,17 @@ const (
 	WebhookEventMessageUpdated      WebhookEvent = "message.updated"
 )
 
+// WebhookStatus indicates what state a Webhook is in.
+// At the moment there are only 2 statuses; enabled or disabled.
+type WebhookStatus string
+
+const (
+	// WebhookStatusEnabled indictates that the webhook is enabled.
+	WebhookStatusEnabled WebhookStatus = "enabled"
+	// WebhookStatusDisabled indictates that the webhook is disabled.
+	WebhookStatusDisabled WebhookStatus = "disabled"
+)
+
 // request does the exact same thing as Client.Request. It does, however,
 // prefix the path with the Conversation API's root. This ensures the client
 // doesn't "handle" this for us: by default, it uses the REST API.

conversation/testdata/webhookObject.json

@@ -6,6 +6,7 @@
         "conversation.created",
         "message.updated"
     ],
+    "status": "enabled",
     "createdDatetime": "2018-08-24T14:24:04Z",
     "updatedDatetime": null
 }

conversation/testdata/webhookUpdateRequest.json

@@ -0,0 +1 @@
+{"events":["conversation.updated"],"url":"https://example.com/mynewwebhookurl","status":"disabled"}

conversation/testdata/webhookUpdatedObject.json

@@ -0,0 +1,11 @@
+{
+    "id": "whid",
+    "url": "https://example.com/mynewwebhookurl",
+    "channelId": "chid",
+    "events": [
+        "conversation.updated"
+    ],
+    "status": "disabled",
+    "createdDatetime": "2018-08-24T14:24:04Z",
+    "updatedDatetime": "2019-07-02T12:00:00Z"
+}

conversation/webhook.go

@@ -12,6 +12,12 @@ type WebhookCreateRequest struct {
 	URL       string         `json:"url"`
 }
 
+type WebhookUpdateRequest struct {
+	Events []WebhookEvent `json:"events,omitempty"`
+	URL    string         `json:"url,omitempty"`
+	Status WebhookStatus  `json:"status,omitempty"`
+}
+
 // CreateWebhook registers a webhook that is invoked when something interesting
 // happens.
 func CreateWebhook(c *messagebird.Client, req *WebhookCreateRequest) (*Webhook, error) {
@@ -50,3 +56,14 @@ func ReadWebhook(c *messagebird.Client, id string) (*Webhook, error) {
 
 	return webhook, nil
 }
+
+// UpdateWebhook updates a single webhook based on its ID with any values set in WebhookUpdateRequest.
+// Do not set any values that should not be updated.
+func UpdateWebhook(c *messagebird.Client, id string, req *WebhookUpdateRequest) (*Webhook, error) {
+	webhook := &Webhook{}
+	if err := request(c, webhook, http.MethodPatch, webhooksPath+"/"+id, req); err != nil {
+		return nil, err
+	}
+
+	return webhook, nil
+}

conversation/webhook_test.go

@@ -85,3 +85,36 @@ func TestReadWebhook(t *testing.T) {
 
 	mbtest.AssertEndpointCalled(t, http.MethodGet, "/v1/webhooks/whid")
 }
+
+func TestUpdateWebhook(t *testing.T) {
+	mbtest.WillReturnTestdata(t, "webhookUpdatedObject.json", http.StatusOK)
+	client := mbtest.Client(t)
+
+	webhookUpdateRequest := &WebhookUpdateRequest{
+		Events: []WebhookEvent{
+			WebhookEventConversationUpdated,
+		},
+		URL:    "https://example.com/mynewwebhookurl",
+		Status: WebhookStatusDisabled,
+	}
+
+	webhook, err := UpdateWebhook(client, "whid", webhookUpdateRequest)
+	if err != nil {
+		t.Fatalf("unexpected error updating Webhook: %s", err)
+	}
+
+	if webhook.URL != "https://example.com/mynewwebhookurl" {
+		t.Fatalf("Expected https://example.com/mynewwebhookurl, got %s", webhook.URL)
+	}
+
+	if webhook.UpdatedDatetime == nil {
+		t.Fatalf("Expected the UpdatedDatetime value to be added, but was nil")
+	}
+
+	if webhook.Status != WebhookStatusDisabled {
+		t.Fatalf("Expected status to be disabled, was %s", webhook.Status)
+	}
+
+	mbtest.AssertEndpointCalled(t, http.MethodPatch, "/v1/webhooks/whid")
+	mbtest.AssertTestdata(t, "webhookUpdateRequest.json", mbtest.Request.Body)
+}