files.com 1.0.266 → 1.0.268

package/_VERSION

@@ -1 +1 @@
-1.0.266
+1.0.268

package/docs/models/Bundle.md

@@ -40,6 +40,7 @@
   "note": "The internal note on the bundle.",
   "path_template": "{{name}}_{{ip}}",
   "send_email_receipt_to_uploader": true,
+  "snapshot_id": 1,
   "user_id": 1,
   "username": "user",
   "clickwrap_id": 1,
@@ -76,6 +77,7 @@
 * `note` (string): Bundle internal note
 * `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
 * `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
+* `snapshot_id` (int64): ID of the snapshot containing this bundle's contents.
 * `user_id` (int64): Bundle creator user ID
 * `username` (string): Bundle creator username
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
@@ -86,6 +88,8 @@
 * `paths` (array): A list of paths in this bundle.  For performance reasons, this is not provided when listing bundles.
 * `password` (string): Password for this bundle.
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
+* `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
+* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
 * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
 * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
 
@@ -136,8 +140,10 @@ await Bundle.create({
   'paths': ["file.txt"],
   'password': "Password",
   'form_field_set_id': 1,
+  'create_snapshot': true,
   'dont_separate_submissions_by_folder': true,
   'expires_at': "2000-01-01T01:00:00Z",
+  'finalize_snapshot': true,
   'max_uses': 1,
   'description': "The public description of the bundle.",
   'note': "The internal note on the bundle.",
@@ -163,8 +169,10 @@ await Bundle.create({
 * `paths` (array(string)): Required - A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
+* `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
 * `dont_separate_submissions_by_folder` (boolean): Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
 * `expires_at` (string): Bundle expiration date/time
+* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
 * `note` (string): Bundle internal note
@@ -217,9 +225,11 @@ await bundle.update({
   'form_field_set_id': 1,
   'clickwrap_id': 1,
   'code': "abc123",
+  'create_snapshot': true,
   'description': "The public description of the bundle.",
   'dont_separate_submissions_by_folder': true,
   'expires_at': "2000-01-01T01:00:00Z",
+  'finalize_snapshot': true,
   'inbox_id': 1,
   'max_uses': 1,
   'note': "The internal note on the bundle.",
@@ -244,9 +254,11 @@ await bundle.update({
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
 * `description` (string): Public description
 * `dont_separate_submissions_by_folder` (boolean): Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
 * `expires_at` (string): Bundle expiration date/time
+* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
 * `inbox_id` (int64): ID of the associated inbox, if available.
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `note` (string): Bundle internal note
@@ -302,6 +314,7 @@ await bundle.update({
   "note": "The internal note on the bundle.",
   "path_template": "{{name}}_{{ip}}",
   "send_email_receipt_to_uploader": true,
+  "snapshot_id": 1,
   "user_id": 1,
   "username": "user",
   "clickwrap_id": 1,

package/docs/models/Snapshot.md

@@ -0,0 +1,99 @@
+# 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.
+
+---
+
+## List Snapshots
+
+```
+await Snapshot.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `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).
+
+---
+
+## Show Snapshot
+
+```
+await Snapshot.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Snapshot ID.
+
+---
+
+## Create Snapshot
+
+```
+await Snapshot.create
+```
+
+
+---
+
+## Update Snapshot
+
+```
+const [snapshot] = await Snapshot.list()
+
+await snapshot.update()
+```
+
+### Parameters
+
+* `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
+}
+```
+
+---
+
+## Delete Snapshot
+
+```
+const [snapshot] = await Snapshot.list()
+
+await snapshot.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Snapshot ID.
+

package/lib/models/Bundle.js

@@ -175,6 +175,13 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   (0, _defineProperty2.default)(this, "setSendEmailReceiptToUploader", function (value) {
     _this.attributes.send_email_receipt_to_uploader = value;
   });
+  // int64 # ID of the snapshot containing this bundle's contents.
+  (0, _defineProperty2.default)(this, "getSnapshotId", function () {
+    return _this.attributes.snapshot_id;
+  });
+  (0, _defineProperty2.default)(this, "setSnapshotId", function (value) {
+    _this.attributes.snapshot_id = value;
+  });
   // int64 # Bundle creator user ID
   (0, _defineProperty2.default)(this, "getUserId", function () {
     return _this.attributes.user_id;
@@ -245,6 +252,20 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   (0, _defineProperty2.default)(this, "setFormFieldSetId", function (value) {
     _this.attributes.form_field_set_id = value;
   });
+  // boolean # If true, create a snapshot of this bundle's contents.
+  (0, _defineProperty2.default)(this, "getCreateSnapshot", function () {
+    return _this.attributes.create_snapshot;
+  });
+  (0, _defineProperty2.default)(this, "setCreateSnapshot", function (value) {
+    _this.attributes.create_snapshot = value;
+  });
+  // boolean # If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
+  (0, _defineProperty2.default)(this, "getFinalizeSnapshot", function () {
+    return _this.attributes.finalize_snapshot;
+  });
+  (0, _defineProperty2.default)(this, "setFinalizeSnapshot", function (value) {
+    _this.attributes.finalize_snapshot = value;
+  });
   // file # Preview watermark image applied to all bundle items.
   (0, _defineProperty2.default)(this, "getWatermarkAttachmentFile", function () {
     return _this.attributes.watermark_attachment_file;
@@ -341,9 +362,11 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
   //   form_field_set_id - int64 - Id of Form Field Set to use with this bundle
   //   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
   //   code - string - Bundle code.  This code forms the end part of the Public URL.
+  //   create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
   //   description - string - Public description
   //   dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
   //   expires_at - string - Bundle expiration date/time
+  //   finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
   //   inbox_id - int64 - ID of the associated inbox, if available.
   //   max_uses - int64 - Maximum number of times bundle can be accessed
   //   note - string - Bundle internal note
@@ -674,8 +697,10 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
 //   paths (required) - array(string) - A list of paths to include in this bundle.
 //   password - string - Password for this bundle.
 //   form_field_set_id - int64 - Id of Form Field Set to use with this bundle
+//   create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
 //   dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
 //   expires_at - string - Bundle expiration date/time
+//   finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
 //   max_uses - int64 - Maximum number of times bundle can be accessed
 //   description - string - Public description
 //   note - string - Bundle internal note

package/lib/models/Snapshot.js

@@ -0,0 +1,322 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+exports.__esModule = true;
+exports.default = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _Api = _interopRequireDefault(require("../Api"));
+var errors = _interopRequireWildcard(require("../Errors"));
+var _Logger = _interopRequireDefault(require("../Logger"));
+var _utils = require("../utils");
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+/**
+ * Class Snapshot
+ */
+var Snapshot = /*#__PURE__*/(0, _createClass2.default)(function Snapshot() {
+  var _this = this;
+  var attributes = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  (0, _classCallCheck2.default)(this, Snapshot);
+  (0, _defineProperty2.default)(this, "attributes", {});
+  (0, _defineProperty2.default)(this, "options", {});
+  (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;
+  });
+  (0, _defineProperty2.default)(this, "setId", function (value) {
+    _this.attributes.id = value;
+  });
+  (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+    var params,
+      response,
+      _args = arguments;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          params = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+          if (_this.attributes.id) {
+            _context.next = 3;
+            break;
+          }
+          throw new errors.EmptyPropertyError('Current object has no id');
+        case 3:
+          if ((0, _utils.isObject)(params)) {
+            _context.next = 5;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
+        case 5:
+          params.id = _this.attributes.id;
+          if (!(params['id'] && !(0, _utils.isInt)(params['id']))) {
+            _context.next = 8;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(id)));
+        case 8:
+          if (params['id']) {
+            _context.next = 14;
+            break;
+          }
+          if (!_this.attributes.id) {
+            _context.next = 13;
+            break;
+          }
+          params['id'] = _this.id;
+          _context.next = 14;
+          break;
+        case 13:
+          throw new errors.MissingParameterError('Parameter missing: id');
+        case 14:
+          _context.next = 16;
+          return _Api.default.sendRequest("/snapshots/".concat(encodeURIComponent(params['id'])), 'PATCH', params, _this.options);
+        case 16:
+          response = _context.sent;
+          return _context.abrupt("return", new Snapshot(response === null || response === void 0 ? void 0 : response.data, _this.options));
+        case 18:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  })));
+  (0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
+    var params,
+      response,
+      _args2 = arguments;
+    return _regenerator.default.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          params = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
+          if (_this.attributes.id) {
+            _context2.next = 3;
+            break;
+          }
+          throw new errors.EmptyPropertyError('Current object has no id');
+        case 3:
+          if ((0, _utils.isObject)(params)) {
+            _context2.next = 5;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
+        case 5:
+          params.id = _this.attributes.id;
+          if (!(params['id'] && !(0, _utils.isInt)(params['id']))) {
+            _context2.next = 8;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(id)));
+        case 8:
+          if (params['id']) {
+            _context2.next = 14;
+            break;
+          }
+          if (!_this.attributes.id) {
+            _context2.next = 13;
+            break;
+          }
+          params['id'] = _this.id;
+          _context2.next = 14;
+          break;
+        case 13:
+          throw new errors.MissingParameterError('Parameter missing: id');
+        case 14:
+          _context2.next = 16;
+          return _Api.default.sendRequest("/snapshots/".concat(encodeURIComponent(params['id'])), 'DELETE', params, _this.options);
+        case 16:
+          response = _context2.sent;
+          return _context2.abrupt("return", response === null || response === void 0 ? void 0 : response.data);
+        case 18:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  })));
+  (0, _defineProperty2.default)(this, "destroy", function () {
+    var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    return _this.delete(params);
+  });
+  (0, _defineProperty2.default)(this, "save", function () {
+    if (_this.attributes['id']) {
+      return _this.update(_this.attributes);
+    } else {
+      var newObject = Snapshot.create(_this.attributes, _this.options);
+      _this.attributes = _objectSpread({}, newObject.attributes);
+      return true;
+    }
+  });
+  Object.entries(attributes).forEach(function (_ref3) {
+    var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
+      key = _ref4[0],
+      value = _ref4[1];
+    var normalizedKey = key.replace('?', '');
+    _this.attributes[normalizedKey] = value;
+    Object.defineProperty(_this, normalizedKey, {
+      value: value,
+      writable: false
+    });
+  });
+  this.options = _objectSpread({}, options);
+});
+// Parameters:
+//   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,
+    _args3 = arguments;
+  return _regenerator.default.wrap(function _callee3$(_context3) {
+    while (1) switch (_context3.prev = _context3.next) {
+      case 0:
+        params = _args3.length > 0 && _args3[0] !== undefined ? _args3[0] : {};
+        options = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : {};
+        if (!(params['cursor'] && !(0, _utils.isString)(params['cursor']))) {
+          _context3.next = 4;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: cursor must be of type String, received ".concat((0, _utils.getType)(params['cursor'])));
+      case 4:
+        if (!(params['per_page'] && !(0, _utils.isInt)(params['per_page']))) {
+          _context3.next = 6;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(params['per_page'])));
+      case 6:
+        _context3.next = 8;
+        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 = 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();
+    }
+  }, _callee3);
+})));
+(0, _defineProperty2.default)(Snapshot, "all", function () {
+  var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return Snapshot.list(params, options);
+});
+// Parameters:
+//   id (required) - int64 - Snapshot ID.
+(0, _defineProperty2.default)(Snapshot, "find", /*#__PURE__*/function () {
+  var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
+    var params,
+      options,
+      response,
+      _args4 = arguments;
+    return _regenerator.default.wrap(function _callee4$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
+        case 0:
+          params = _args4.length > 1 && _args4[1] !== undefined ? _args4[1] : {};
+          options = _args4.length > 2 && _args4[2] !== undefined ? _args4[2] : {};
+          if ((0, _utils.isObject)(params)) {
+            _context4.next = 4;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
+        case 4:
+          params['id'] = id;
+          if (params['id']) {
+            _context4.next = 7;
+            break;
+          }
+          throw new errors.MissingParameterError('Parameter missing: id');
+        case 7:
+          if (!(params['id'] && !(0, _utils.isInt)(params['id']))) {
+            _context4.next = 9;
+            break;
+          }
+          throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params['id'])));
+        case 9:
+          _context4.next = 11;
+          return _Api.default.sendRequest("/snapshots/".concat(encodeURIComponent(params['id'])), 'GET', params, options);
+        case 11:
+          response = _context4.sent;
+          return _context4.abrupt("return", new Snapshot(response === null || response === void 0 ? void 0 : response.data, options));
+        case 13:
+        case "end":
+          return _context4.stop();
+      }
+    }, _callee4);
+  }));
+  return function (_x) {
+    return _ref6.apply(this, arguments);
+  };
+}());
+(0, _defineProperty2.default)(Snapshot, "get", function (id) {
+  var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+  return Snapshot.find(id, params, options);
+});
+(0, _defineProperty2.default)(Snapshot, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
+  var options,
+    response,
+    _args5 = arguments;
+  return _regenerator.default.wrap(function _callee5$(_context5) {
+    while (1) switch (_context5.prev = _context5.next) {
+      case 0:
+        options = _args5.length > 0 && _args5[0] !== undefined ? _args5[0] : {};
+        _context5.next = 3;
+        return _Api.default.sendRequest("/snapshots", 'POST', {}, options);
+      case 3:
+        response = _context5.sent;
+        return _context5.abrupt("return", new Snapshot(response === null || response === void 0 ? void 0 : response.data, options));
+      case 5:
+      case "end":
+        return _context5.stop();
+    }
+  }, _callee5);
+})));
+var _default = Snapshot;
+exports.default = _default;

package/package.json

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

package/src/models/Bundle.js

@@ -166,6 +166,13 @@ class Bundle {
     this.attributes.send_email_receipt_to_uploader = value
   }
 
+  // int64 # ID of the snapshot containing this bundle's contents.
+  getSnapshotId = () => this.attributes.snapshot_id
+
+  setSnapshotId = value => {
+    this.attributes.snapshot_id = value
+  }
+
   // int64 # Bundle creator user ID
   getUserId = () => this.attributes.user_id
 
@@ -236,6 +243,20 @@ class Bundle {
     this.attributes.form_field_set_id = value
   }
 
+  // boolean # If true, create a snapshot of this bundle's contents.
+  getCreateSnapshot = () => this.attributes.create_snapshot
+
+  setCreateSnapshot = value => {
+    this.attributes.create_snapshot = value
+  }
+
+  // boolean # If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
+  getFinalizeSnapshot = () => this.attributes.finalize_snapshot
+
+  setFinalizeSnapshot = value => {
+    this.attributes.finalize_snapshot = value
+  }
+
   // file # Preview watermark image applied to all bundle items.
   getWatermarkAttachmentFile = () => this.attributes.watermark_attachment_file
 
@@ -299,9 +320,11 @@ class Bundle {
   //   form_field_set_id - int64 - Id of Form Field Set to use with this bundle
   //   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
   //   code - string - Bundle code.  This code forms the end part of the Public URL.
+  //   create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
   //   description - string - Public description
   //   dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
   //   expires_at - string - Bundle expiration date/time
+  //   finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
   //   inbox_id - int64 - ID of the associated inbox, if available.
   //   max_uses - int64 - Maximum number of times bundle can be accessed
   //   note - string - Bundle internal note
@@ -480,8 +503,10 @@ class Bundle {
   //   paths (required) - array(string) - A list of paths to include in this bundle.
   //   password - string - Password for this bundle.
   //   form_field_set_id - int64 - Id of Form Field Set to use with this bundle
+  //   create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
   //   dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
   //   expires_at - string - Bundle expiration date/time
+  //   finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
   //   max_uses - int64 - Maximum number of times bundle can be accessed
   //   description - string - Public description
   //   note - string - Bundle internal note

package/src/models/Snapshot.js

@@ -0,0 +1,188 @@
+import Api from '../Api'
+import * as errors from '../Errors'
+import Logger from '../Logger'
+import { getType, isArray, isBrowser, isInt, isObject, isString } from '../utils'
+
+/**
+ * Class Snapshot
+ */
+class Snapshot {
+  attributes = {}
+  options = {}
+
+  constructor(attributes = {}, options = {}) {
+    Object.entries(attributes).forEach(([key, value]) => {
+      const normalizedKey = key.replace('?', '')
+
+      this.attributes[normalizedKey] = value
+
+      Object.defineProperty(this, normalizedKey, { value, writable: false })
+    })
+
+    this.options = { ...options }
+  }
+
+  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
+
+  setId = value => {
+    this.attributes.id = value
+  }
+
+
+  update = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new errors.EmptyPropertyError('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params['id'] && !isInt(params['id'])) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(id)}`)
+    }
+
+    if (!params['id']) {
+      if (this.attributes.id) {
+        params['id'] = this.id
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: id')
+      }
+    }
+
+    const response = await Api.sendRequest(`/snapshots/${encodeURIComponent(params['id'])}`, 'PATCH', params, this.options)
+
+    return new Snapshot(response?.data, this.options)
+  }
+
+  delete = async (params = {}) => {
+    if (!this.attributes.id) {
+      throw new errors.EmptyPropertyError('Current object has no id')
+    }
+
+    if (!isObject(params)) {
+      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params.id = this.attributes.id
+    if (params['id'] && !isInt(params['id'])) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(id)}`)
+    }
+
+    if (!params['id']) {
+      if (this.attributes.id) {
+        params['id'] = this.id
+      } else {
+        throw new errors.MissingParameterError('Parameter missing: id')
+      }
+    }
+
+    const response = await Api.sendRequest(`/snapshots/${encodeURIComponent(params['id'])}`, 'DELETE', params, this.options)
+
+    return response?.data
+  }
+
+  destroy = (params = {}) =>
+    this.delete(params)
+
+  save = () => {
+      if (this.attributes['id']) {
+        return this.update(this.attributes)
+      } else {
+        const newObject = Snapshot.create(this.attributes, this.options)
+        this.attributes = { ...newObject.attributes }
+        return true
+      }
+  }
+
+  // Parameters:
+  //   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).
+  static list = async (params = {}, options = {}) => {
+    if (params['cursor'] && !isString(params['cursor'])) {
+      throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params['cursor'])}`)
+    }
+
+    if (params['per_page'] && !isInt(params['per_page'])) {
+      throw new errors.InvalidParameterError(`Bad parameter: per_page must be of type Int, received ${getType(params['per_page'])}`)
+    }
+
+    const response = await Api.sendRequest(`/snapshots`, 'GET', params, options)
+
+    return response?.data?.map(obj => new Snapshot(obj, options)) || []
+  }
+
+  static all = (params = {}, options = {}) =>
+    Snapshot.list(params, options)
+
+  // Parameters:
+  //   id (required) - int64 - Snapshot ID.
+  static find = async (id, params = {}, options = {}) => {
+    if (!isObject(params)) {
+      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
+    }
+
+    params['id'] = id
+
+    if (!params['id']) {
+      throw new errors.MissingParameterError('Parameter missing: id')
+    }
+
+    if (params['id'] && !isInt(params['id'])) {
+      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params['id'])}`)
+    }
+
+    const response = await Api.sendRequest(`/snapshots/${encodeURIComponent(params['id'])}`, 'GET', params, options)
+
+    return new Snapshot(response?.data, options)
+  }
+
+  static get = (id, params = {}, options = {}) =>
+    Snapshot.find(id, params, options)
+
+  static create = async (options = {}) => {
+    const response = await Api.sendRequest(`/snapshots`, 'POST', {}, options)
+
+    return new Snapshot(response?.data, options)
+  }
+}
+
+export default Snapshot