files.com 1.0.216 → 1.0.217

package/_VERSION

@@ -1 +1 @@
-1.0.216
+1.0.217

package/docs/models/ApiKey.md

@@ -6,6 +6,7 @@
 {
   "id": 1,
   "descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
+  "description": "",
   "created_at": "2000-01-01T01:00:00Z",
   "expires_at": "2000-01-01T01:00:00Z",
   "key": "[key]",
@@ -20,6 +21,7 @@
 
 * `id` (int64): API Key ID
 * `descriptive_label` (string): Unique label that describes this API key.  Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
+* `description` (string): User-supplied description of API key.
 * `created_at` (date-time): Time which API Key was created
 * `expires_at` (date-time): API Key expiration date
 * `key` (string): API Key actual key string
@@ -96,6 +98,7 @@ await ApiKey.create({
 
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `name` (string): Internal name for the API Key.  For your use.
+* `description` (string): User-supplied description of API key.
 * `expires_at` (string): API Key expiration date
 * `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 * `path` (string): Folder path restriction for this api key.
@@ -146,6 +149,7 @@ await api_key.update({
 
 * `id` (int64): Required - Api Key ID.
 * `name` (string): Internal name for the API Key.  For your use.
+* `description` (string): User-supplied description of API key.
 * `expires_at` (string): API Key expiration date
 * `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 
@@ -155,6 +159,7 @@ await api_key.update({
 {
   "id": 1,
   "descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
+  "description": "",
   "created_at": "2000-01-01T01:00:00Z",
   "expires_at": "2000-01-01T01:00:00Z",
   "key": "[key]",

package/lib/models/ApiKey.js

@@ -61,6 +61,12 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
   (0, _defineProperty2.default)(this, "setDescriptiveLabel", function (value) {
     _this.attributes.descriptive_label = value;
   });
+  (0, _defineProperty2.default)(this, "getDescription", function () {
+    return _this.attributes.description;
+  });
+  (0, _defineProperty2.default)(this, "setDescription", function (value) {
+    _this.attributes.description = value;
+  });
   (0, _defineProperty2.default)(this, "getCreatedAt", function () {
     return _this.attributes.created_at;
   });
@@ -156,48 +162,56 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
             throw new errors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0, _utils.getType)(name)));
 
           case 10:
-            if (!(params['expires_at'] && !(0, _utils.isString)(params['expires_at']))) {
+            if (!(params['description'] && !(0, _utils.isString)(params['description']))) {
               _context.next = 12;
               break;
             }
 
-            throw new errors.InvalidParameterError("Bad parameter: expires_at must be of type String, received ".concat((0, _utils.getType)(expires_at)));
+            throw new errors.InvalidParameterError("Bad parameter: description must be of type String, received ".concat((0, _utils.getType)(description)));
 
           case 12:
-            if (!(params['permission_set'] && !(0, _utils.isString)(params['permission_set']))) {
+            if (!(params['expires_at'] && !(0, _utils.isString)(params['expires_at']))) {
               _context.next = 14;
               break;
             }
 
-            throw new errors.InvalidParameterError("Bad parameter: permission_set must be of type String, received ".concat((0, _utils.getType)(permission_set)));
+            throw new errors.InvalidParameterError("Bad parameter: expires_at must be of type String, received ".concat((0, _utils.getType)(expires_at)));
 
           case 14:
+            if (!(params['permission_set'] && !(0, _utils.isString)(params['permission_set']))) {
+              _context.next = 16;
+              break;
+            }
+
+            throw new errors.InvalidParameterError("Bad parameter: permission_set must be of type String, received ".concat((0, _utils.getType)(permission_set)));
+
+          case 16:
             if (params['id']) {
-              _context.next = 20;
+              _context.next = 22;
               break;
             }
 
             if (!_this.attributes.id) {
-              _context.next = 19;
+              _context.next = 21;
               break;
             }
 
             params['id'] = _this.id;
-            _context.next = 20;
+            _context.next = 22;
             break;
 
-          case 19:
+          case 21:
             throw new errors.MissingParameterError('Parameter missing: id');
 
-          case 20:
-            _context.next = 22;
+          case 22:
+            _context.next = 24;
             return _Api.default.sendRequest("/api_keys/".concat(encodeURIComponent(params['id'])), 'PATCH', params, _this.options);
 
-          case 22:
+          case 24:
             response = _context.sent;
             return _context.abrupt("return", new ApiKey(response === null || response === void 0 ? void 0 : response.data, _this.options));
 
-          case 24:
+          case 26:
           case "end":
             return _context.stop();
         }
@@ -472,38 +486,46 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
           throw new errors.InvalidParameterError("Bad parameter: name must be of type String, received ".concat((0, _utils.getType)(params['name'])));
 
         case 6:
-          if (!(params['expires_at'] && !(0, _utils.isString)(params['expires_at']))) {
+          if (!(params['description'] && !(0, _utils.isString)(params['description']))) {
             _context6.next = 8;
             break;
           }
 
-          throw new errors.InvalidParameterError("Bad parameter: expires_at must be of type String, received ".concat((0, _utils.getType)(params['expires_at'])));
+          throw new errors.InvalidParameterError("Bad parameter: description must be of type String, received ".concat((0, _utils.getType)(params['description'])));
 
         case 8:
-          if (!(params['permission_set'] && !(0, _utils.isString)(params['permission_set']))) {
+          if (!(params['expires_at'] && !(0, _utils.isString)(params['expires_at']))) {
             _context6.next = 10;
             break;
           }
 
-          throw new errors.InvalidParameterError("Bad parameter: permission_set must be of type String, received ".concat((0, _utils.getType)(params['permission_set'])));
+          throw new errors.InvalidParameterError("Bad parameter: expires_at must be of type String, received ".concat((0, _utils.getType)(params['expires_at'])));
 
         case 10:
-          if (!(params['path'] && !(0, _utils.isString)(params['path']))) {
+          if (!(params['permission_set'] && !(0, _utils.isString)(params['permission_set']))) {
             _context6.next = 12;
             break;
           }
 
-          throw new errors.InvalidParameterError("Bad parameter: path must be of type String, received ".concat((0, _utils.getType)(params['path'])));
+          throw new errors.InvalidParameterError("Bad parameter: permission_set must be of type String, received ".concat((0, _utils.getType)(params['permission_set'])));
 
         case 12:
-          _context6.next = 14;
-          return _Api.default.sendRequest("/api_keys", 'POST', params, options);
+          if (!(params['path'] && !(0, _utils.isString)(params['path']))) {
+            _context6.next = 14;
+            break;
+          }
+
+          throw new errors.InvalidParameterError("Bad parameter: path must be of type String, received ".concat((0, _utils.getType)(params['path'])));
 
         case 14:
+          _context6.next = 16;
+          return _Api.default.sendRequest("/api_keys", 'POST', params, options);
+
+        case 16:
           response = _context6.sent;
           return _context6.abrupt("return", new ApiKey(response === null || response === void 0 ? void 0 : response.data, options));
 
-        case 16:
+        case 18:
         case "end":
           return _context6.stop();
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.0.216",
+  "version": "1.0.217",
   "description": "Files.com SDK for JavaScript",
   "keywords": [
     "files.com",

package/src/models/ApiKey.js

@@ -37,6 +37,13 @@ class ApiKey {
     this.attributes.descriptive_label = value
   }
 
+  // string # User-supplied description of API key.
+  getDescription = () => this.attributes.description
+
+  setDescription = value => {
+    this.attributes.description = value
+  }
+
   // date-time # Time which API Key was created
   getCreatedAt = () => this.attributes.created_at
 
@@ -99,6 +106,7 @@ class ApiKey {
 
   // Parameters:
   //   name - string - Internal name for the API Key.  For your use.
+  //   description - string - User-supplied description of API key.
   //   expires_at - string - API Key expiration date
   //   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
   update = async (params = {}) => {
@@ -117,6 +125,9 @@ class ApiKey {
     if (params['name'] && !isString(params['name'])) {
       throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(name)}`)
     }
+    if (params['description'] && !isString(params['description'])) {
+      throw new errors.InvalidParameterError(`Bad parameter: description must be of type String, received ${getType(description)}`)
+    }
     if (params['expires_at'] && !isString(params['expires_at'])) {
       throw new errors.InvalidParameterError(`Bad parameter: expires_at must be of type String, received ${getType(expires_at)}`)
     }
@@ -243,6 +254,7 @@ class ApiKey {
   // Parameters:
   //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
   //   name - string - Internal name for the API Key.  For your use.
+  //   description - string - User-supplied description of API key.
   //   expires_at - string - API Key expiration date
   //   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
   //   path - string - Folder path restriction for this api key.
@@ -255,6 +267,10 @@ class ApiKey {
       throw new errors.InvalidParameterError(`Bad parameter: name must be of type String, received ${getType(params['name'])}`)
     }
 
+    if (params['description'] && !isString(params['description'])) {
+      throw new errors.InvalidParameterError(`Bad parameter: description must be of type String, received ${getType(params['description'])}`)
+    }
+
     if (params['expires_at'] && !isString(params['expires_at'])) {
       throw new errors.InvalidParameterError(`Bad parameter: expires_at must be of type String, received ${getType(params['expires_at'])}`)
     }