Add endpoint for DELETE /streams/<stream_id>

README.md

@@ -114,6 +114,7 @@ zulip.callEndpoint('/messages', 'POST', params);
 | `zulip.streams.retrieve()` | GET `/streams` | returns a promise that can be used to retrieve all streams. |
 | `zulip.streams.getStreamId()` | GET `/get_stream_id` | returns a promise that can be used to retrieve a stream's id. |
 | `zulip.streams.subscriptions.retrieve()` | GET `/users/me/subscriptions` | returns a promise that can be used to retrieve the user's subscriptions. |
+| `zulip.streams.deleteById()` | DELETE `/streams/<stream_id>` | delete the stream with the provided stream id if the user has permission to do so. |
 | `zulip.streams.topics.retrieve()` | GET `/users/me/<stream_id>/topics` | retrieves all the topics in a specific stream. |
 | `zulip.typing.send()` | POST `/typing` | can be used to send a typing notification. The parameters required are `to` (either a username or a list of usernames) and `op` (either `start` or `stop`). |
 | `zulip.users.retrieve()` | GET `/users` | retrieves all users for this realm. |

src/resources/streams.js

@@ -28,6 +28,10 @@ function streams(config) {
         return api(url, config, 'GET');
       },
     },
+    deleteById: (params) => {
+      const url = `${config.apiURL}/streams/${params.stream_id}`;
+      return api(url, config, 'DELETE', params);
+    },
   };
 }
 

test/resources/streams.js

@@ -170,4 +170,26 @@ describe('Streams', () => {
       })
       .catch(done);
   });
+
+  it('should delete stream by stream id', (done) => {
+    const params = {
+      stream_id: 1,
+    };
+    const validator = (url, options) => {
+      url.should.contain(`${common.config.apiURL}/streams/${params.stream_id}`);
+      options.should.not.have.property('body');
+      options.method.should.be.equal('DELETE');
+    };
+    const output = {
+      msg: '',
+      result: 'success',
+    };
+    const stubs = common.getStubs(validator, output);
+    streams(common.config).deleteById(params)
+      .then((data) => {
+        data.should.have.property('result', 'success');
+        common.restoreStubs(stubs);
+        done();
+      }).catch(done);
+  });
 });