feat(responses): add delete method to remove responses

Author: MichaelSolati

README.md

@@ -198,6 +198,12 @@ Each one of them encapsulates the operations related to it (like listing, updati
 
 ### Responses
 
+#### `responses.delete({ uid, ids })`
+
+- Delete responses to a form.
+- `uid`: Unique ID for the form.
+- `ids`: Tokens of the responses to delete. You can list up to 1000 tokens. Accepts either a string or an array of strings.
+
 #### `responses.list({ uid, pageSize, since, until, after, before, ids, completed, sort, query, fields })`
 
 - Returns form responses and date and time of form landing and submission.

src/responses.js

@@ -5,6 +5,16 @@ class Responses {
     this._http = _http
   }
 
+  delete ({ uid, ids }) {
+    return this._http.request({
+      method: 'delete',
+      url: `/forms/${uid}/responses`,
+      params: {
+        included_tokens: toCSL(ids)
+      }
+    })
+  }
+
   list ({ uid, pageSize, since, until, after, before, ids, completed, sort, query, fields } = {}) {
     return this._http.request({
       method: 'get',

tests/unit/responses.test.js

@@ -25,3 +25,15 @@ test('List responses with the given filters', () => {
   expect(params.get('page_size')).toBe('15')
   expect(params.get('after')).toBe('12345')
 })
+
+test('Delete responses has the correct path and method when given string for `ids`', () => {
+  responsesRequest.delete({ uid: 2, ids: '123' })
+  expect(fetch.mock.calls[0][1].method).toBe('delete')
+  expect(fetch.mock.calls[0][0]).toBe(`${API_BASE_URL}/forms/2/responses?included_tokens=123`)
+})
+
+test('Delete responses has the correct path and method when given array of strings for `ids`', () => {
+  responsesRequest.delete({ uid: 2, ids: ['123', '456', '789'] })
+  expect(fetch.mock.calls[0][1].method).toBe('delete')
+  expect(fetch.mock.calls[0][0]).toBe(`${API_BASE_URL}/forms/2/responses?included_tokens=123%2C456%2C789`)
+})