@beauraines/rtm-api 1.14.3 → 1.15.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.15.0](https://github.com/beauraines/rtm-api/compare/v1.14.3...v1.15.0) (2026-05-23)
+
+
+### Features
+
+* Implement unarchiving lists ([#92](https://github.com/beauraines/rtm-api/issues/92)) ([8946e4c](https://github.com/beauraines/rtm-api/commit/8946e4c6f9d4fd75e0f10e40962a2dd54c8455ac))
+
 ### [1.14.3](https://github.com/beauraines/rtm-api/compare/v1.14.1...v1.14.3) (2026-03-24)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/rtm-api",
-  "version": "1.14.3",
+  "version": "1.15.0",
   "description": "Remember the Milk API Interface",
   "author": "David Waring <dev@davidwaring.net> (https://davidwaring.net)",
   "contributors": [

package/src/list/helper.js

@@ -122,10 +122,28 @@ function archive(id, user, callback) {
   });
 }
 
+/**
+ * API Call: rtm.lists.unarchive
+ * @param id RTM List ID
+ * @param user RTMUser
+ * @param callback Callback function(err)
+ * @private
+ */
+function unarchive(id, user, callback) {
+  let params = {
+    timeline: user.timeline,
+    list_id: id
+  };
+  user.get('rtm.lists.unarchive', params,  function(err) {
+    return callback(err);
+  });
+}
+
 module.exports = {
   get: get,
   add: add,
   remove: remove,
   rename: rename,
-  archive: archive
+  archive: archive,
+  unarchive: unarchive
 };

package/src/user/lists.js

@@ -7,7 +7,7 @@ const _lists = require('../list/helper.js');
 /**
  * This module returns the RTM list-related functions for the RTMUser
  * @param {RTMUser} user RTM User instance
- * @returns {{get: function, update: function, add: function, remove: function, rename: function, archive: function}}
+ * @returns {{get: function, update: function, add: function, remove: function, rename: function, archive: function, unarchive: function}}
  * @private
  */
 module.exports = function(user) {
@@ -134,7 +134,7 @@ module.exports = function(user) {
         }
       }
 
-      // Remove the matching List
+      // Archive the matching List
       if ( ids.length === 1 ) {
         return _lists.archive(ids[0], user, callback);
       }
@@ -146,5 +146,39 @@ module.exports = function(user) {
 
   };
 
+  /**
+   * Unarchive the specified RTM List for this User
+   * @param {string} name RTM List Name
+   * @param {function} callback Callback function(err)
+   * @param {RTMError} callback.err RTM API Error Response, if encountered
+   * @function RTMUser~lists/unarchive
+   */
+  rtn.unarchive = function(name, callback) {
+    // Get the User's Lists
+    _lists.get(user, function(err, lists) {
+      if ( err ) {
+        return callback(err);
+      }
+
+      // Find the matching list IDs
+      let ids = [];
+      for ( let i = 0; i < lists.length; i++ ) {
+        if ( lists[i].name.toLowerCase() === name.toLowerCase() ) {
+          ids.push(lists[i].id);
+        }
+      }
+
+      // Unarchive the matching List
+      if ( ids.length === 1 ) {
+        return _lists.unarchive(ids[0], user, callback);
+      }
+      else {
+        return callback(errors.referenceError());
+      }
+
+    });
+
+  };
+
   return rtn;
 };