Merge pull request #268 from pierce-m/redact-attachment

Add support for ticket comment attachment redaction

Author: nukosuke

fixture/PUT/redact_ticket_comment_attachment.json

@@ -0,0 +1,11 @@
+{
+  "attachment": {
+    "content_type": "application/binary",
+    "content_url": "https://company.zendesk.com/attachments/myfile.dat",
+    "file_name": "myfile.dat",
+    "id": 498483,
+    "size": 2532,
+    "thumbnails": [],
+    "url": "https://company.zendesk.com/api/v2/attachments/498483.json"
+  }
+}

zendesk/attachment.go

@@ -196,3 +196,11 @@ func (z *Client) GetAttachment(ctx context.Context, id int64) (Attachment, error
 
 	return result.Attachment, nil
 }
+
+// RedactCommentAttachment deletes an attachment with attachmentID on comment with commentID for ticket with ticketID
+// https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/#redact-comment-attachment
+func (z *Client) RedactCommentAttachment(ctx context.Context, ticketID, commentID, attachmentID int64) error {
+	path := fmt.Sprintf("/api/v2/tickets/%d/comments/%d/attachments/%d/redact", ticketID, commentID, attachmentID)
+	_, err := z.put(ctx, path, nil)
+	return err
+}

zendesk/attachment_test.go

@@ -118,3 +118,15 @@ func TestGetAttachment(t *testing.T) {
 		t.Fatalf("Returned attachment does not have the expected ID %d. Attachment id is %d", expectedID, attachment.ID)
 	}
 }
+
+func TestRedactCommentAttachment(t *testing.T) {
+	mockAPI := newMockAPI(http.MethodPut, "redact_ticket_comment_attachment.json")
+	client := newTestClient(mockAPI)
+	defer mockAPI.Close()
+
+	err := client.RedactCommentAttachment(ctx, 123, 456, 789)
+
+	if err != nil {
+		t.Fatalf("Failed to redact ticket comment attachment: %s", err)
+	}
+}