Basic pagination

Author: bobjflong

README.md

@@ -80,6 +80,24 @@ client.events.create({
 });
 ```
 
+## Pagination
+
+When listing, the Intercom API may return a pagination object:
+
+```json
+{
+  "pages": {
+    "next": "..."
+  }
+}
+```
+
+You can grab the next page of results using the client:
+
+```
+client.nextPage(response.pages, callback);
+```
+
 ## License
 
 Apache-2.0

lib/client.js

@@ -32,6 +32,13 @@ export class Client {
     .header('Accept', 'application/json')
     .end(r => f(r));
   }
+  nextPage(paginationObject, f) {
+    unirest.get(paginationObject.next)
+    .auth(this.appId, this.appApiKey)
+    .type('json')
+    .header('Accept', 'application/json')
+    .end(r => f(r));
+  }
   delete(endpoint, data, f) {
     unirest.delete(`https://api.intercom.io${endpoint}`)
     .auth(this.appId, this.appApiKey)

test/index.js

@@ -16,4 +16,13 @@ describe('clients', function () {
       done();
     });
   });
+  it('paginate', function (done) {
+    nock('https://api.intercom.io').get('/foo/bar/baz').query({ blue: 'red' }).reply(200, { foo: 'bar' });
+    let client = new Client('foo', 'bar');
+    let paginationObject = { next: 'https://api.intercom.io/foo/bar/baz?blue=red' };
+    client.nextPage(paginationObject, function (r) {
+      assert.deepEqual({foo: 'bar'}, r.body);
+      done();
+    });
+  });
 });