fix(segment): require limit param in listContacts

The parameter is required in the API and should be so in the SDK as well.
emartech · Nov 12, 2015 · 1424bc6 · 1424bc6
1 parent a5f7c3c
commit 1424bc6
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -292,7 +292,7 @@ In the example above, the API will be called with `customerId = 20234245`.
 
     suiteAPI.segment.listContacts(payload);
 
-##### List contacts
+##### List segments
 
     suiteAPI.segment.listSegments(payload);
 

diff --git a/api/endpoints/segment/index.js b/api/endpoints/segment/index.js
@@ -16,7 +16,7 @@ util.inherits(Segment, Base);
 _.extend(Segment.prototype, {
 
   listContacts: function(payload, options) {
-    return this._requireParameters(payload, ['segment_id']).then(function() {
+    return this._requireParameters(payload, ['segment_id', 'limit']).then(function() {
       var url = util.format('/filter/%s/contacts', payload.segment_id);
       logger.log('segment_list_contacts');
 

diff --git a/api/endpoints/segment/index.spec.js b/api/endpoints/segment/index.spec.js
@@ -12,16 +12,19 @@ describe('SuiteAPI Segment endpoint', function() {
 
   describe('#listContacts', function() {
     testApiMethod(SegmentAPI, 'listContacts').withArgs({
-      segment_id: 10
-    }).shouldGetResultFromEndpoint('/filter/10/contacts');
+      segment_id: 10,
+      limit: 100
+    }).shouldGetResultFromEndpoint('/filter/10/contacts/?limit=100');
 
     testApiMethod(SegmentAPI, 'listContacts').withArgs({
       segment_id: 10,
       limit: 100,
       offset: 0
     }).shouldGetResultFromEndpoint('/filter/10/contacts/?limit=100&offset=0');
 
-    testApiMethod(SegmentAPI, 'listContacts').withArgs({}).shouldThrowMissingParameterError('segment_id');
+    testApiMethod(SegmentAPI, 'listContacts').withArgs({ limit: 100 }).shouldThrowMissingParameterError('segment_id');
+
+    testApiMethod(SegmentAPI, 'listContacts').withArgs({ segment_id: 10 }).shouldThrowMissingParameterError('limit');
   });
 
 });