Added new sharing endpoints. Deprecated old sharing endpoints. (#115)

* Added new sharing endpoints.

Deprecated old sharing endpoints.

* test fixes

* lint

* lint

* result -> items.

* Change method sharing method signatures to be more consistent

* Fix typo getSightPublshStatus to getSightPublishStatus, address nit in test, address ListShareOptions comment and queryParameter unpacking

* Revert backward compatibility changes to reports, sheets, sights, workspaces shares, fix tests

* Add dotenv, use dotenv in sharing-test

* Fix lint errors, revert dotenv changes

* Fix query parameters and sharing options for consistency

* Make singular those query params interfaces that were plural

* Remove empty ListSharesOption and use the QueryParams directly

* prettier fix

* Revert deletion of ListSharesOptions, add lint exception for empty interface

---------

Co-authored-by: Miguel Martinez <[email protected]>

Author: nslugic

CHANGELOG.md

@@ -5,6 +5,22 @@ 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.7.0] - 2025-06-30
+### Added
+- Support for new asset-based sharing endpoints in a new `sharing` module:
+  - `listAssetShares`: List all shares for a specified asset
+  - `getAssetShare`: Get a specific share for a specified asset
+  - `shareAsset`: Share an asset with specified users and/or groups
+  - `updateAssetShare`: Update a specific share for a specified asset
+  - `deleteAssetShare`: Delete a specific share for a specified asset
+- Added TypeScript interfaces and enums for the sharing API
+
+### Updated
+- Deprecated old sharing endpoints in the `share` module
+- Added backward compatibility wrappers in sheets, reports, workspaces, and sights modules
+- Added deprecation notices and migration examples in documentation
+- Fix typo in SightsApi (`getSightPublshStatus` to `getSightPublishStatus`)
+
 ## 4.6.0 - 2025-09-25
 ### Added
   - Support for upgrade/downgrade endpoints

index.ts

@@ -3,6 +3,7 @@ import { apiUrls } from './lib/utils/apis';
 import { createContacts } from './lib/contacts';
 import { createEvents } from './lib/events';
 import { createSearch } from './lib/search';
+import { createSharing } from './lib/sharing';
 import { createSights } from './lib/sights';
 
 const _ = require('underscore');
@@ -112,6 +113,7 @@ export const createClient: CreateClient = function (clientOptions) {
     request: require('./lib/request/').create(options),
     search: createSearch(options),
     server: require('./lib/server/').create(options),
+    sharing: createSharing(options),
     sheets: require('./lib/sheets/').create(options),
     sights: createSights(options),
     templates: require('./lib/templates/').create(options),
@@ -130,3 +132,4 @@ export const smartSheetURIs = {
 
 export { CreateClient, CreateClientOptions, SmartsheetClient } from './lib/types';
 export * from './lib/events/types';
+export * from './lib/sharing';

lib/reports/index.js

@@ -2,6 +2,7 @@ var _ = require('underscore');
 var constants = require('../utils/constants.js');
 
 exports.create = function (options) {
+  // Legacy shares module (deprecated)
   var shares = require('../share/share.js')(options.apiUrls.reports);
   var requestor = options.requestor;
 

lib/share/share.js

@@ -1,26 +1,59 @@
 var _ = require('underscore');
 
+/**
+ * @deprecated
+ * The share module is deprecated. Please use the new sharing module instead.
+ * The new sharing module provides asset-based sharing endpoints that support
+ * all asset types (sheets, reports, sights, workspaces, etc.) through a unified API.
+ *
+ * Example migration:
+ *
+ * Old:
+ * ```
+ * client.sheets.getSheetShares({ sheetId: 123 });
+ * ```
+ *
+ * New:
+ * ```
+ * client.sharing.listAssetShares({ assetType: 'sheet', assetId: 123 });
+ * ```
+ */
 module.exports = (url) => ({
+  /**
+   * @deprecated Use the new sharing module instead
+   */
   create: function (options) {
     var requestor = options.requestor;
 
     var optionsToSend = _.extend({}, options.clientOptions);
 
+    /**
+     * @deprecated Use sharing.listAssetShares instead
+     */
     var listShares = (getOptions, callback) => {
       var urlOptions = { url: buildUrl(getOptions) };
       return requestor.get(_.extend({}, optionsToSend, urlOptions, getOptions), callback);
     };
 
+    /**
+     * @deprecated Use sharing.shareAsset instead
+     */
     var share = (postOptions, callback) => {
       var urlOptions = { url: buildUrl(postOptions) };
       return requestor.post(_.extend({}, optionsToSend, urlOptions, postOptions), callback);
     };
 
+    /**
+     * @deprecated Use sharing.deleteShare instead
+     */
     var deleteShare = (deleteOptions, callback) => {
       var urlOptions = { url: buildUrl(deleteOptions) };
       return requestor.delete(_.extend({}, optionsToSend, urlOptions, deleteOptions), callback);
     };
 
+    /**
+     * @deprecated Use sharing.updateShare instead
+     */
     var updateShare = (putOptions, callback) => {
       var urlOptions = { url: buildUrl(putOptions) };
       return requestor.put(_.extend({}, optionsToSend, urlOptions, putOptions), callback);
@@ -33,10 +66,25 @@ module.exports = (url) => ({
       (urlOptions.shareId || '');
 
     return {
+      /**
+       * @deprecated Use sharing.getAssetShare instead
+       */
       getShare: listShares,
+      /**
+       * @deprecated Use sharing.listShares instead
+       */
       listShares: listShares,
+      /**
+       * @deprecated Use sharing.shareAsset instead
+       */
       share: share,
+      /**
+       * @deprecated Use sharing.deleteShare instead
+       */
       deleteShare: deleteShare,
+      /**
+       * @deprecated Use sharing.updateShare instead
+       */
       updateShare: updateShare,
     };
   },