Merge pull request #130 from smartsheet/remove-trailing-slash

Remove trailing slashes

Author: denislavstanchev

CHANGELOG.md

@@ -5,13 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [4.8.0] - Unreleased
+## [x.x.x] - Unreleased
 ### Added
 - WiremMock integration tests for contract testing for GET /2.0/users/{userId}/plans and GET /2.0/users endpoints
 - WireMock integration tests for contract testing for POST /2.0/users/{userId}/plans/{planId}/upgrade and POST /2.0/users/{userId}/plans/{planId}/downgrade
+- Remove trailing slashes from routes
 ### Updated
 - listAllUsers url generation
 - Folder structure for the Users related WireMock tests
+- Update endpoint and sheet tests
 
 ## [4.7.0] - 2025-06-30
 ### Added

lib/contacts/index.ts

@@ -13,13 +13,19 @@ import type { RequestOptions } from './../types/RequestOptions';
 export function createContacts(options: CreateOptions): ContactsApi {
   const requestor = options.requestor;
 
+  const baseUrl = options.apiUrls.contacts;
   const optionsToSend = {
-    url: options.apiUrls.contacts,
+    url: baseUrl,
     ...options.clientOptions,
   };
 
-  const getContact = (options: RequestOptions<GetContactOptions, GetContactBody>, callback: RequestCallback<Contact>) =>
-    requestor.get({ ...optionsToSend, ...options }, callback);
+  const getContact = (
+    options: RequestOptions<GetContactOptions, GetContactBody>,
+    callback: RequestCallback<Contact>
+  ) => {
+    const urlWithSlash = baseUrl + '/';
+    return requestor.get({ ...optionsToSend, url: urlWithSlash, ...options }, callback);
+  };
 
   const listContacts = (
     options: RequestOptions<ListContactsOptions, undefined>,

lib/favorites/index.js

@@ -53,7 +53,9 @@ exports.create = (options) => {
     }
 
     var urlOptions = {
-      url: options.apiUrls.favorites + deleteOptions.type + '/' + (deleteOptions.id || deleteOptions.objectId || ''),
+      url: deleteOptions.objectId
+        ? options.apiUrls.favorites + '/' + deleteOptions.type + '/' + deleteOptions.objectId
+        : options.apiUrls.favorites + '/' + deleteOptions.type,
     };
     return requestor.delete(_.extend({}, optionsToSend, urlOptions, deleteOptions), callback);
   };

lib/folders/index.js

@@ -22,27 +22,32 @@ exports.create = function (options) {
    */
   var listChildFolders = (getOptions, callback) => {
     console.warn('DEPRECATED: Folders.listChildFolders is deprecated. Use getFolderChildren instead.');
-    var urlOptions = { url: options.apiUrls.folders + getOptions.folderId + '/folders' };
+    var urlOptions = { url: options.apiUrls.folders + '/' + getOptions.folderId + '/folders' };
     return requestor.get(_.extend({}, optionsToSend, urlOptions, getOptions), callback);
   };
 
   var createChildFolder = (postOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.folders + postOptions.folderId + '/folders' };
+    var urlOptions = { url: options.apiUrls.folders + '/' + postOptions.folderId + '/folders' };
     return requestor.post(_.extend({}, optionsToSend, urlOptions, postOptions), callback);
   };
 
-  var updateFolder = (putOptions, callback) => requestor.put(_.extend({}, optionsToSend, putOptions), callback);
+  var updateFolder = (putOptions, callback) => {
+    var urlOptions = { url: options.apiUrls.folders + '/' + putOptions.folderId };
+    requestor.put(_.extend({}, optionsToSend, urlOptions, putOptions), callback);
+  };
 
-  var deleteFolder = (deleteOptions, callback) =>
-    requestor.delete(_.extend({}, optionsToSend, deleteOptions), callback);
+  var deleteFolder = (deleteOptions, callback) => {
+    var urlOptions = { url: options.apiUrls.folders + '/' + deleteOptions.folderId };
+    requestor.delete(_.extend({}, optionsToSend, urlOptions, deleteOptions), callback);
+  };
 
   var copyFolder = (postOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.folders + postOptions.folderId + '/copy' };
+    var urlOptions = { url: options.apiUrls.folders + '/' + postOptions.folderId + '/copy' };
     return requestor.post(_.extend({}, optionsToSend, urlOptions, postOptions), callback);
   };
 
   var moveFolder = (postOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.folders + postOptions.folderId + '/move' };
+    var urlOptions = { url: options.apiUrls.folders + '/' + postOptions.folderId + '/move' };
     return requestor.post(_.extend({}, optionsToSend, urlOptions, postOptions), callback);
   };
 
@@ -55,7 +60,7 @@ exports.create = function (options) {
    * @param {Function} callback - Callback function
    */
   var getFolderMetadata = (getOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.folders + getOptions.folderId + '/metadata' };
+    var urlOptions = { url: options.apiUrls.folders + '/' + getOptions.folderId + '/metadata' };
     return requestor.get(_.extend({}, optionsToSend, urlOptions, getOptions), callback);
   };
 
@@ -71,7 +76,7 @@ exports.create = function (options) {
    * @param {Function} callback - Callback function
    */
   var getFolderChildren = (getOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.folders + getOptions.folderId + '/children' };
+    var urlOptions = { url: options.apiUrls.folders + '/' + getOptions.folderId + '/children' };
     return requestor.get(_.extend({}, optionsToSend, urlOptions, getOptions), callback);
   };
 

lib/groups/index.js

@@ -13,16 +13,22 @@ exports.create = function (options) {
   var createGroup = (postOptions, callback) => requestor.post(_.extend({}, optionsToSend, postOptions), callback);
 
   var addGroupMembers = (postOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.groups + postOptions.groupId + '/members/' };
+    var urlOptions = { url: options.apiUrls.groups + '/' + postOptions.groupId + '/members' };
     return requestor.post(_.extend({}, optionsToSend, urlOptions, postOptions), callback);
   };
 
-  var updateGroup = (putOptions, callback) => requestor.put(_.extend({}, optionsToSend, putOptions), callback);
+  var updateGroup = (putOptions, callback) => {
+    var urlOptions = { url: options.apiUrls.groups + '/' + putOptions.groupId };
+    requestor.put(_.extend({}, optionsToSend, urlOptions, putOptions), callback);
+  };
 
-  var deleteGroup = (deleteOptions, callback) => requestor.delete(_.extend({}, optionsToSend, deleteOptions), callback);
+  var deleteGroup = (deleteOptions, callback) => {
+    var urlOptions = { url: options.apiUrls.groups + '/' + deleteOptions.groupId };
+    requestor.delete(_.extend({}, optionsToSend, urlOptions, deleteOptions), callback);
+  };
 
   var removeGroupMember = (deleteOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.groups + deleteOptions.groupId + '/members/' + deleteOptions.userId };
+    var urlOptions = { url: options.apiUrls.groups + '/' + deleteOptions.groupId + '/members/' + deleteOptions.userId };
     return requestor.delete(_.extend({}, optionsToSend, urlOptions, deleteOptions), callback);
   };
 

lib/home/index.js

@@ -21,15 +21,15 @@ exports.create = function (options) {
    */
   var listFolders = (getOptions, callback) => {
     console.warn('DEPRECATED: Home.listFolders is deprecated.');
-    return listContents(_.extend({ url: options.apiUrls.home + 'folders' }, getOptions), callback);
+    return listContents(_.extend({ url: options.apiUrls.home + '/' + 'folders' }, getOptions), callback);
   };
 
   /**
    * @deprecated See: https://developers.smartsheet.com/api/smartsheet/guides/updating-code/migrate-from-using-the-sheets-folder
    */
   var createFolder = (postOptions, callback) => {
     console.warn('DEPRECATED: Home.createFolder is deprecated.');
-    var urlOptions = { url: options.apiUrls.home + 'folders' };
+    var urlOptions = { url: options.apiUrls.home + '/' + 'folders' };
     return requestor.post(_.extend({}, optionsToSend, urlOptions, postOptions), callback);
   };
 

lib/reports/index.js

@@ -12,31 +12,38 @@ exports.create = function (options) {
   _.extend(optionsToSend, options.clientOptions);
 
   var getReport = (getOptions, callback) => {
-    return requestor.get(_.extend({}, optionsToSend, getOptions), callback);
+    let url = options.apiUrls.reports;
+    if (getOptions?.reportId) {
+      url += '/' + getOptions.reportId;
+    }
+    var urlOptions = { url };
+    return requestor.get(_.extend({}, optionsToSend, urlOptions, getOptions), callback);
   };
 
   var sendReportViaEmail = (postOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.reports + postOptions.reportId + '/emails' };
+    var urlOptions = { url: options.apiUrls.reports + '/' + postOptions.reportId + '/emails' };
     return requestor.post(_.extend({}, optionsToSend, urlOptions, postOptions), callback);
   };
 
   var getReportAsExcel = (getOptions, callback) => {
     var acceptOptions = { accept: constants.acceptHeaders.vndMsExcel, encoding: null };
-    return requestor.get(_.extend({}, optionsToSend, acceptOptions, getOptions), callback);
+    var urlOptions = { url: options.apiUrls.reports + '/' + getOptions.reportId };
+    return requestor.get(_.extend({}, optionsToSend, acceptOptions, urlOptions, getOptions), callback);
   };
 
   var getReportAsCSV = (getOptions, callback) => {
     var acceptOptions = { accept: constants.acceptHeaders.textCsv };
-    return requestor.get(_.extend({}, optionsToSend, acceptOptions, getOptions), callback);
+    var urlOptions = { url: options.apiUrls.reports + '/' + getOptions.reportId };
+    return requestor.get(_.extend({}, optionsToSend, acceptOptions, urlOptions, getOptions), callback);
   };
 
   var getReportPublishStatus = (getOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.reports + getOptions.reportId + '/publish' };
+    var urlOptions = { url: options.apiUrls.reports + '/' + getOptions.reportId + '/publish' };
     return requestor.get(_.extend({}, optionsToSend, urlOptions, getOptions), callback);
   };
 
   var setReportPublishStatus = (putOptions, callback) => {
-    var urlOptions = { url: options.apiUrls.reports + putOptions.reportId + '/publish' };
+    var urlOptions = { url: options.apiUrls.reports + '/' + putOptions.reportId + '/publish' };
     return requestor.put(_.extend({}, optionsToSend, urlOptions, putOptions), callback);
   };
 

lib/search/index.ts

@@ -1,4 +1,5 @@
 import type { CreateOptions, RequestCallback } from '../types';
+import { apiUrls } from '../utils/apis';
 import type { SearchAllOptions, SearchApi, SearchResponse, SearchSheetOptions } from './types';
 
 export const createSearch = (options: CreateOptions): SearchApi => {
@@ -29,10 +30,11 @@ export const createSearch = (options: CreateOptions): SearchApi => {
       ...getOptions,
       queryParameters: {
         query: getOptions.query,
-        sheetId: getOptions.sheetId,
       },
     };
 
+    options.url = apiUrls.search + '/sheets/' + getOptions.sheetId;
+
     return requestor.get(options, callback);
   };
 

lib/share/share.js

@@ -61,9 +61,10 @@ module.exports = (url) => ({
 
     var buildUrl = (urlOptions) =>
       url +
+      '/' +
       (urlOptions.sheetId || urlOptions.workspaceId || urlOptions.reportId || urlOptions.sightId) +
-      '/shares/' +
-      (urlOptions.shareId || '');
+      '/shares' +
+      (urlOptions.shareId !== undefined ? '/' + urlOptions.shareId : '');
 
     return {
       /**

lib/sheets/attachments.js

@@ -40,8 +40,13 @@ exports.create = function (options) {
     return requestor.delete(_.extend({}, optionsToSend, urlOptions, deleteOptions), callback);
   };
 
-  var buildUrl = (urlOptions) =>
-    options.apiUrls.sheets + urlOptions.sheetId + '/attachments/' + (urlOptions.attachmentId || '');
+  var buildUrl = (urlOptions) => {
+    let url = options.apiUrls.sheets + '/' + urlOptions.sheetId + '/attachments';
+    if (urlOptions.attachmentId !== undefined) {
+      url += '/' + urlOptions.attachmentId;
+    }
+    return url;
+  };
 
   return {
     getAttachment: listAttachments,