files.com 1.0.267 → 1.0.269

package/_VERSION

@@ -1 +1 @@
-1.0.267
+1.0.269

package/docs/models/Behavior.md

@@ -17,7 +17,7 @@
 ```
 
 * `id` (int64): Folder behavior ID
-* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `path` (string): Folder path.  Note that Behavior paths cannot be updated once initially set.  You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `attachment_url` (string): URL for attached file
 * `behavior` (string): Behavior type.
 * `name` (string): Name for this behavior.

package/docs/models/Folder.md

@@ -70,7 +70,7 @@ await Folder.listFor(path, {
 * `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 * `path` (string): Required - Path to operate on.
-* `filter` (string): If specified, will filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
+* `filter` (string): If specified, will filter folders/files list by name. Ignores text before last `/`. Wildcards of `*` and `?` are acceptable here.
 * `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 * `sort_by` (object): Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
 * `search` (string): If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.

package/docs/models/Snapshot.md

@@ -1,5 +1,22 @@
 # Snapshot
 
+## Example Snapshot Object
+
+```
+{
+  "expires_at": "2000-01-01T01:00:00Z",
+  "finalized_at": "2000-01-01T01:00:00Z",
+  "name": "My Snapshot",
+  "user_id": 1,
+  "bundle_id": 1
+}
+```
+
+* `expires_at` (date-time): When the snapshot expires.
+* `finalized_at` (date-time): When the snapshot was finalized.
+* `name` (string): A name for the snapshot.
+* `user_id` (int64): The user that created this snapshot, if applicable.
+* `bundle_id` (int64): The bundle using this snapshot, if applicable.
 * `id` (int64): Snapshot ID.
 
 ---
@@ -54,6 +71,17 @@ await snapshot.update()
 
 * `id` (int64): Required - Snapshot ID.
 
+### Example Response
+
+```json
+{
+  "expires_at": "2000-01-01T01:00:00Z",
+  "finalized_at": "2000-01-01T01:00:00Z",
+  "name": "My Snapshot",
+  "user_id": 1,
+  "bundle_id": 1
+}
+```
 
 ---
 

package/lib/models/Behavior.js

@@ -38,7 +38,7 @@ var Behavior = /*#__PURE__*/(0, _createClass2.default)(function Behavior() {
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
-  // string # Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+  // string # Folder path.  Note that Behavior paths cannot be updated once initially set.  You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
   (0, _defineProperty2.default)(this, "getPath", function () {
     return _this.attributes.path;
   });

package/lib/models/Folder.js

@@ -184,7 +184,7 @@ var Folder = /*#__PURE__*/(0, _createClass2.default)(function Folder() {
 //   cursor - string - Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 //   path (required) - string - Path to operate on.
-//   filter - string - If specified, will filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
+//   filter - string - If specified, will filter folders/files list by name. Ignores text before last `/`. Wildcards of `*` and `?` are acceptable here.
 //   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 //   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
 //   search - string - If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.

package/lib/models/Snapshot.js

@@ -31,6 +31,41 @@ var Snapshot = /*#__PURE__*/(0, _createClass2.default)(function Snapshot() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // date-time # When the snapshot expires.
+  (0, _defineProperty2.default)(this, "getExpiresAt", function () {
+    return _this.attributes.expires_at;
+  });
+  (0, _defineProperty2.default)(this, "setExpiresAt", function (value) {
+    _this.attributes.expires_at = value;
+  });
+  // date-time # When the snapshot was finalized.
+  (0, _defineProperty2.default)(this, "getFinalizedAt", function () {
+    return _this.attributes.finalized_at;
+  });
+  (0, _defineProperty2.default)(this, "setFinalizedAt", function (value) {
+    _this.attributes.finalized_at = value;
+  });
+  // string # A name for the snapshot.
+  (0, _defineProperty2.default)(this, "getName", function () {
+    return _this.attributes.name;
+  });
+  (0, _defineProperty2.default)(this, "setName", function (value) {
+    _this.attributes.name = value;
+  });
+  // int64 # The user that created this snapshot, if applicable.
+  (0, _defineProperty2.default)(this, "getUserId", function () {
+    return _this.attributes.user_id;
+  });
+  (0, _defineProperty2.default)(this, "setUserId", function (value) {
+    _this.attributes.user_id = value;
+  });
+  // int64 # The bundle using this snapshot, if applicable.
+  (0, _defineProperty2.default)(this, "getBundleId", function () {
+    return _this.attributes.bundle_id;
+  });
+  (0, _defineProperty2.default)(this, "setBundleId", function (value) {
+    _this.attributes.bundle_id = value;
+  });
   // int64 # Snapshot ID.
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
@@ -83,7 +118,7 @@ var Snapshot = /*#__PURE__*/(0, _createClass2.default)(function Snapshot() {
           return _Api.default.sendRequest("/snapshots/".concat(encodeURIComponent(params['id'])), 'PATCH', params, _this.options);
         case 16:
           response = _context.sent;
-          return _context.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+          return _context.abrupt("return", new Snapshot(response === null || response === void 0 ? void 0 : response.data, _this.options));
         case 18:
         case "end":
           return _context.stop();
@@ -172,6 +207,7 @@ var Snapshot = /*#__PURE__*/(0, _createClass2.default)(function Snapshot() {
 //   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 (0, _defineProperty2.default)(Snapshot, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
+  var _response$data;
   var params,
     options,
     response,
@@ -197,7 +233,9 @@ var Snapshot = /*#__PURE__*/(0, _createClass2.default)(function Snapshot() {
         return _Api.default.sendRequest("/snapshots", 'GET', params, options);
       case 8:
         response = _context3.sent;
-        return _context3.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+        return _context3.abrupt("return", (response === null || response === void 0 ? void 0 : (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
+          return new Snapshot(obj, options);
+        })) || []);
       case 10:
       case "end":
         return _context3.stop();
@@ -245,7 +283,7 @@ var Snapshot = /*#__PURE__*/(0, _createClass2.default)(function Snapshot() {
           return _Api.default.sendRequest("/snapshots/".concat(encodeURIComponent(params['id'])), 'GET', params, options);
         case 11:
           response = _context4.sent;
-          return _context4.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+          return _context4.abrupt("return", new Snapshot(response === null || response === void 0 ? void 0 : response.data, options));
         case 13:
         case "end":
           return _context4.stop();
@@ -273,7 +311,7 @@ var Snapshot = /*#__PURE__*/(0, _createClass2.default)(function Snapshot() {
         return _Api.default.sendRequest("/snapshots", 'POST', {}, options);
       case 3:
         response = _context5.sent;
-        return _context5.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+        return _context5.abrupt("return", new Snapshot(response === null || response === void 0 ? void 0 : response.data, options));
       case 5:
       case "end":
         return _context5.stop();

package/package.json

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

package/src/models/Behavior.js

@@ -30,7 +30,7 @@ class Behavior {
     this.attributes.id = value
   }
 
-  // string # Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+  // string # Folder path.  Note that Behavior paths cannot be updated once initially set.  You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
   getPath = () => this.attributes.path
 
   setPath = value => {

package/src/models/Folder.js

@@ -164,7 +164,7 @@ class Folder {
   //   cursor - string - Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
   //   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
   //   path (required) - string - Path to operate on.
-  //   filter - string - If specified, will filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
+  //   filter - string - If specified, will filter folders/files list by name. Ignores text before last `/`. Wildcards of `*` and `?` are acceptable here.
   //   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
   //   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
   //   search - string - If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.

package/src/models/Snapshot.js

@@ -23,6 +23,41 @@ class Snapshot {
   }
 
   isLoaded = () => !!this.attributes.id
+  // date-time # When the snapshot expires.
+  getExpiresAt = () => this.attributes.expires_at
+
+  setExpiresAt = value => {
+    this.attributes.expires_at = value
+  }
+
+  // date-time # When the snapshot was finalized.
+  getFinalizedAt = () => this.attributes.finalized_at
+
+  setFinalizedAt = value => {
+    this.attributes.finalized_at = value
+  }
+
+  // string # A name for the snapshot.
+  getName = () => this.attributes.name
+
+  setName = value => {
+    this.attributes.name = value
+  }
+
+  // int64 # The user that created this snapshot, if applicable.
+  getUserId = () => this.attributes.user_id
+
+  setUserId = value => {
+    this.attributes.user_id = value
+  }
+
+  // int64 # The bundle using this snapshot, if applicable.
+  getBundleId = () => this.attributes.bundle_id
+
+  setBundleId = value => {
+    this.attributes.bundle_id = value
+  }
+
   // int64 # Snapshot ID.
   getId = () => this.attributes.id
 
@@ -55,7 +90,7 @@ class Snapshot {
 
     const response = await Api.sendRequest(`/snapshots/${encodeURIComponent(params['id'])}`, 'PATCH', params, this.options)
 
-    return response?.data
+    return new Snapshot(response?.data, this.options)
   }
 
   delete = async (params = {}) => {
@@ -112,7 +147,7 @@ class Snapshot {
 
     const response = await Api.sendRequest(`/snapshots`, 'GET', params, options)
 
-    return response?.data
+    return response?.data?.map(obj => new Snapshot(obj, options)) || []
   }
 
   static all = (params = {}, options = {}) =>
@@ -137,7 +172,7 @@ class Snapshot {
 
     const response = await Api.sendRequest(`/snapshots/${encodeURIComponent(params['id'])}`, 'GET', params, options)
 
-    return response?.data
+    return new Snapshot(response?.data, options)
   }
 
   static get = (id, params = {}, options = {}) =>
@@ -146,7 +181,7 @@ class Snapshot {
   static create = async (options = {}) => {
     const response = await Api.sendRequest(`/snapshots`, 'POST', {}, options)
 
-    return response?.data
+    return new Snapshot(response?.data, options)
   }
 }