Merge pull request #64 from smartsheet-platform/feature/sheet-summary…

…-endpoints

Add sheet summary endpoints.

.travis.yml

@@ -1,5 +1,7 @@
 language: node_js
 
+dist: trusty
+
 node_js:
   - "lts/carbon"
 
@@ -27,4 +29,4 @@ deploy:
   on:
     repo: smartsheet-platform/smartsheet-javascript-sdk
     branch: master
-after_deploy: "echo 'Finished deployment process'"
+after_deploy: "echo 'Finished deployment process'"

CHANGELOG.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
+## 2.77.3 - Aug 16, 2019
+- Added support for the following sheet summary methods:
+    - `sheets.getSummary`
+    - `sheets.getSummaryFields`
+    - `sheets.addSummaryFields`
+    - `sheets.deleteSummaryFields`
+    - `sheets.updateSummaryFields`
+    - `sheets.addSummaryFieldImage`
 
 ## 2.77.2 - Aug 9, 2019
 - Updated the following dependencies due to security vulnerabilities:

lib/sheets/index.js

@@ -7,6 +7,7 @@ var createSheets = require('./create.js');
 var crossSheetReferences = require('./crosssheetreferences.js');
 var discussions = require('./discussions');
 var getSheets = require('./get.js');
+var summaries = require('./sheetsummaries.js');
 var rows = require('./rows.js');
 var sentUpdateRequests = require('./sentupdaterequests.js');
 var updateRequests = require('./updaterequests.js');
@@ -74,6 +75,7 @@ exports.create = function(options) {
   _.extend(sheetObject, crossSheetReferences.create(options));
   _.extend(sheetObject, discussions.create(options));
   _.extend(sheetObject, getSheets.create(options));
+  _.extend(sheetObject, summaries.create(options));
   _.extend(sheetObject, rows.create(options));
   _.extend(sheetObject, sentUpdateRequests.create(options));
   _.extend(sheetObject, shares.create(options));

lib/sheets/sheetsummaries.js

@@ -0,0 +1,53 @@
+var _ = require('underscore');
+
+exports.create = function(options) {
+  var requestor = options.requestor;
+
+  var optionsToSend = _.extend({}, options.clientOptions);
+
+  var getSummary = (getOptions, callback) => {
+    var urlOptions = {url: buildSummaryUrl(getOptions)};
+    return requestor.get(_.extend({}, optionsToSend, urlOptions, getOptions), callback);
+  }
+
+  var getSummaryFields = (getOptions, callback) => {
+    var urlOptions = {url: buildFieldsUrl(getOptions)};
+    return requestor.get(_.extend({}, optionsToSend, urlOptions, getOptions), callback);
+  }
+
+  var addSummaryFields = (postOptions, callback) => {
+    var urlOptions = {url: buildFieldsUrl(postOptions)};
+    return requestor.post(_.extend({}, optionsToSend, urlOptions, postOptions), callback);
+  }
+
+  var deleteSummaryFields = (deleteOptions, callback) => {
+    var urlOptions = {url: buildFieldsUrl(deleteOptions)};
+    return requestor.delete(_.extend({}, optionsToSend, urlOptions, deleteOptions), callback);
+  }
+
+  var updateSummaryFields = (putOptions, callback) => {
+    var urlOptions = {url: buildFieldsUrl(putOptions)};
+    return requestor.put(_.extend({}, optionsToSend, urlOptions, putOptions), callback);
+  }
+
+  var addSummaryFieldImage = (postOptions, callback) => {
+    var urlOptions = {url: buildFieldImagesUrl(postOptions)};
+    return requestor.postFile(_.extend({}, optionsToSend, urlOptions, postOptions), callback);
+  }
+
+  var buildSummaryUrl = urlOptions => options.apiUrls.sheets + urlOptions.sheetId + '/summary';
+
+  var buildFieldsUrl = urlOptions => buildSummaryUrl(urlOptions) + '/fields'
+
+  var buildFieldImagesUrl = urlOptions =>
+    buildFieldsUrl(urlOptions) + '/' + urlOptions.fieldId + '/images'
+
+  return {
+    getSummary: getSummary,
+    getSummaryFields: getSummaryFields,
+    addSummaryFields: addSummaryFields,
+    deleteSummaryFields: deleteSummaryFields,
+    updateSummaryFields: updateSummaryFields,
+    addSummaryFieldImage: addSummaryFieldImage
+  };
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartsheet",
-  "version": "2.77.2",
+  "version": "2.77.3",
   "description": "Smartsheet JavaScript client SDK",
   "main": "index.js",
   "scripts": {

test/functional/endpoints_test.js

@@ -201,6 +201,13 @@ describe('Method Unit Tests', function () {
                 { name: 'getSheetAsPDF', stub: 'get', options: {}, expectedRequest: {url: "sheets/", accept: constants.acceptHeaders.applicationPdf, encoding:null}},
                 { name: 'getSheetVersion', stub: 'get', options: {sheetId: 123}, expectedRequest: {url: "sheets/123/version"}},
                 { name: 'listOrganizationSheets', stub: 'get', options: undefined, expectedRequest: {url: "users/sheets"}},
+                // summaries
+                { name: 'getSummary', stub: 'get', options: {sheetId: 123}, expectedRequest: {url: "sheets/123/summary"}},
+                { name: 'getSummaryFields', stub: 'get', options: {sheetId: 123}, expectedRequest: {url: "sheets/123/summary/fields"}},
+                { name: 'addSummaryFields', stub: 'post', options: {sheetId: 123, body: {}}, expectedRequest: {url: "sheets/123/summary/fields"}},
+                { name: 'deleteSummaryFields', stub: 'delete', options: {sheetId: 123}, expectedRequest: {url: "sheets/123/summary/fields"}},
+                { name: 'updateSummaryFields', stub: 'put', options: {sheetId: 123, body: {}}, expectedRequest: {url: "sheets/123/summary/fields"}},
+                { name: 'addSummaryFieldImage', stub: 'postFile', options: {sheetId: 123, fieldId: 234}, expectedRequest: {url: "sheets/123/summary/fields/234/images"}},
                 // rows
                 { name: 'getRow', stub: 'get', options: {sheetId: 123, rowId: 234}, expectedRequest: {url: "sheets/123/rows/234"}},
                 { name: 'getRowAttachments', stub: 'get', options: {sheetId: 123, rowId: 234}, expectedRequest: {url: "sheets/123/rows/234/attachments"}},