files.com 1.0.221 → 1.0.223

package/_VERSION

@@ -1 +1 @@
-1.0.221
+1.0.223

package/docs/models/Bundle.md

@@ -19,9 +19,11 @@
   "skip_company": true,
   "id": 1,
   "created_at": "2000-01-01T01:00:00Z",
+  "dont_separate_submissions_by_folder": true,
   "expires_at": "2000-01-01T01:00:00Z",
   "max_uses": 1,
   "note": "The internal note on the bundle.",
+  "path_template": "{{name}}_{{ip}}",
   "user_id": 1,
   "username": "user",
   "clickwrap_id": 1,
@@ -52,9 +54,11 @@
 * `skip_company` (boolean): BundleRegistrations can be saved without providing company?
 * `id` (int64): Bundle ID
 * `created_at` (date-time): Bundle created at date/time
+* `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` (date-time): Bundle expiration date/time
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `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.
 * `user_id` (int64): Bundle creator user ID
 * `username` (string): Bundle creator username
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
@@ -116,11 +120,13 @@ await Bundle.create({
   'paths': ["file.txt"],
   'password': "Password",
   'form_field_set_id': 1,
+  'dont_separate_submissions_by_folder': true,
   'expires_at': "2000-01-01T01:00:00Z",
   'max_uses': 1,
   'description': "The public description of the bundle.",
   'note': "The internal note on the bundle.",
   'code': "abc123",
+  'path_template': "{{name}}_{{ip}}",
   'permissions': "read",
   'preview_only': true,
   'require_registration': true,
@@ -140,11 +146,13 @@ 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
+* `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
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
 * `permissions` (string): Permissions that apply to Folders in this Share Link.
 * `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
@@ -192,10 +200,12 @@ await bundle.update({
   'clickwrap_id': 1,
   'code': "abc123",
   'description': "The public description of the bundle.",
+  'dont_separate_submissions_by_folder': true,
   'expires_at': "2000-01-01T01:00:00Z",
   'inbox_id': 1,
   'max_uses': 1,
   'note': "The internal note on the bundle.",
+  'path_template': "{{name}}_{{ip}}",
   'permissions': "read",
   'preview_only': true,
   'require_registration': true,
@@ -216,10 +226,12 @@ await bundle.update({
 * `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.
 * `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
 * `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
+* `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
 * `permissions` (string): Permissions that apply to Folders in this Share Link.
 * `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
@@ -249,9 +261,11 @@ await bundle.update({
   "skip_company": true,
   "id": 1,
   "created_at": "2000-01-01T01:00:00Z",
+  "dont_separate_submissions_by_folder": true,
   "expires_at": "2000-01-01T01:00:00Z",
   "max_uses": 1,
   "note": "The internal note on the bundle.",
+  "path_template": "{{name}}_{{ip}}",
   "user_id": 1,
   "username": "user",
   "clickwrap_id": 1,

package/lib/Api.js

@@ -1,46 +1,26 @@
 "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 _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 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 _axios = _interopRequireDefault(require("axios"));
-
 var _axiosRetry = _interopRequireDefault(require("axios-retry"));
-
 var _Files = _interopRequireDefault(require("./Files"));
-
 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; }
-
 var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
   (0, _classCallCheck2.default)(this, Api);
 });
@@ -49,7 +29,6 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
     retries: _Files.default.getMaxNetworkRetries(),
     retryDelay: function retryDelay(retries) {
       _Logger.default.info("Retrying request (retry ".concat(retries, " of ").concat(_Files.default.getMaxNetworkRetries(), ")"));
-
       return Math.min(retries * _Files.default.getMinNetworkRetryDelay() * 1000, _Files.default.getMaxNetworkRetryDelay() * 1000);
     }
   });
@@ -63,27 +42,20 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
           case 0:
             isExternal = /^[a-zA-Z]+:\/\//.test(path);
             baseUrl = _Files.default.getBaseUrl();
-
             if (!(!isExternal && !baseUrl)) {
               _context.next = 4;
               break;
             }
-
             throw new errors.ConfigurationError('Base URL has not been set - use Files.setBaseUrl() to set it');
-
           case 4:
             url = isExternal ? path : "".concat(baseUrl).concat(_Files.default.getEndpointPrefix()).concat(path);
-
             _Logger.default.debug("Sending request: ".concat(verb, " ").concat(url));
-
             _Logger.default.debug('Sending options:', _objectSpread(_objectSpread({}, options), {}, {
               headers: _objectSpread(_objectSpread({}, options.headers), {}, {
                 'X-FilesAPI-Key': '<redacted>'
               })
             }));
-
             Api._configureAutoRetry();
-
             _context.prev = 8;
             _context.next = 11;
             return (0, _axios.default)(_objectSpread({
@@ -91,30 +63,23 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
               timeout: _Files.default.getNetworkTimeout() * 1000,
               url: url
             }, options));
-
           case 11:
             response = _context.sent;
-
             _Logger.default.debug("Status: ".concat(response.status, " ").concat(response.statusText));
-
             if (_Files.default.shouldDebugResponseHeaders()) {
               _Logger.default.debug('Response Headers: ');
-
               _Logger.default.debug(response.headers);
             }
-
             return _context.abrupt("return", {
               status: response.status,
               reason: response.statusText,
               headers: response.headers,
               data: response.data
             });
-
           case 17:
             _context.prev = 17;
             _context.t0 = _context["catch"](8);
             errors.handleErrorResponse(_context.t0);
-
           case 20:
           case "end":
             return _context.stop();
@@ -122,7 +87,6 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
       }
     }, _callee, null, [[8, 17]]);
   }));
-
   return function (_x, _x2, _x3) {
     return _ref.apply(this, arguments);
   };
@@ -132,19 +96,15 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
   var params = {
     data: data
   };
-
   if (headers) {
     params.headers = headers;
   }
-
   return Api._sendVerbatim(externalUrl, verb, params);
 });
 (0, _defineProperty2.default)(Api, "_autoPaginate", /*#__PURE__*/function () {
   var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(path, verb, params, options, response, metadata) {
     var _options$autoPaginate;
-
     var _response$headers, nextCursor, _ref3, autoPaginateCount, previousAutoPaginateData, nextPage, nextParams, nextMetadata;
-
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) {
         switch (_context2.prev = _context2.next) {
@@ -153,15 +113,12 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
               _context2.next = 12;
               break;
             }
-
             nextCursor = response === null || response === void 0 ? void 0 : (_response$headers = response.headers) === null || _response$headers === void 0 ? void 0 : _response$headers['x-files-cursor'];
             _ref3 = metadata || {}, autoPaginateCount = _ref3.autoPaginateCount, previousAutoPaginateData = _ref3.previousAutoPaginateData;
-
             if (!nextCursor) {
               _context2.next = 10;
               break;
             }
-
             nextPage = (Number(params === null || params === void 0 ? void 0 : params.page) || 1) + 1;
             nextParams = _objectSpread(_objectSpread({}, params), {}, {
               cursor: nextCursor,
@@ -172,21 +129,17 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
               previousAutoPaginateData: [].concat((0, _toConsumableArray2.default)(previousAutoPaginateData || []), (0, _toConsumableArray2.default)((response === null || response === void 0 ? void 0 : response.data) || []))
             };
             return _context2.abrupt("return", Api.sendRequest(path, verb, nextParams, options, nextMetadata));
-
           case 10:
             if (!previousAutoPaginateData) {
               _context2.next = 12;
               break;
             }
-
             return _context2.abrupt("return", _objectSpread(_objectSpread({}, response), {}, {
               autoPaginateRequests: autoPaginateCount,
               data: [].concat((0, _toConsumableArray2.default)(previousAutoPaginateData), (0, _toConsumableArray2.default)((response === null || response === void 0 ? void 0 : response.data) || []))
             }));
-
           case 12:
             return _context2.abrupt("return", response);
-
           case 13:
           case "end":
             return _context2.stop();
@@ -194,7 +147,6 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
       }
     }, _callee2);
   }));
-
   return function (_x4, _x5, _x6, _x7, _x8, _x9) {
     return _ref2.apply(this, arguments);
   };
@@ -202,19 +154,19 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
 (0, _defineProperty2.default)(Api, "sendRequest", /*#__PURE__*/function () {
   var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(path, verb) {
     var params,
-        options,
-        metadata,
-        headers,
-        isExternal,
-        sessionId,
-        isCreatingSession,
-        apiKey,
-        updatedOptions,
-        requestPath,
-        hasParams,
-        pairs,
-        response,
-        _args3 = arguments;
+      options,
+      metadata,
+      headers,
+      isExternal,
+      sessionId,
+      isCreatingSession,
+      apiKey,
+      updatedOptions,
+      requestPath,
+      hasParams,
+      pairs,
+      response,
+      _args3 = arguments;
     return _regenerator.default.wrap(function _callee3$(_context3) {
       while (1) {
         switch (_context3.prev = _context3.next) {
@@ -228,57 +180,44 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
               'User-Agent': _Files.default.getUserAgent()
             });
             isExternal = /^[a-zA-Z]+:\/\//.test(path);
-
             if (isExternal) {
               _context3.next = 17;
               break;
             }
-
             sessionId = options.sessionId || _Files.default.getSessionId();
-
             if (!sessionId) {
               _context3.next = 11;
               break;
             }
-
             headers['X-FilesAPI-Auth'] = sessionId;
             _context3.next = 17;
             break;
-
           case 11:
             isCreatingSession = path === '/sessions' && verb.toUpperCase() === 'POST'; // api key cannot be used when creating a session
-
             if (isCreatingSession) {
               _context3.next = 17;
               break;
             }
-
             apiKey = options.apiKey || _Files.default.getApiKey();
-
             if (apiKey) {
               _context3.next = 16;
               break;
             }
-
             throw new errors.ConfigurationError('API key has not been set - use Files.setApiKey() to set it');
-
           case 16:
             headers['X-FilesAPI-Key'] = apiKey;
-
           case 17:
             updatedOptions = _objectSpread(_objectSpread({}, options), {}, {
               headers: headers
             });
             requestPath = path;
             hasParams = (0, _utils.isObject)(params) && !(0, _utils.isEmpty)(params);
-
             if (hasParams) {
               if (verb.toUpperCase() === 'GET') {
                 pairs = Object.entries(params).map(function (_ref5) {
                   var _ref6 = (0, _slicedToArray2.default)(_ref5, 2),
-                      key = _ref6[0],
-                      value = _ref6[1];
-
+                    key = _ref6[0],
+                    value = _ref6[1];
                   return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
                 });
                 requestPath += path.includes('?') ? '&' : '?';
@@ -288,10 +227,8 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
                 headers['Content-Type'] = 'application/json';
               }
             }
-
             if (_Files.default.shouldDebugRequest()) {
               _Logger.default.debug('Request Options:');
-
               _Logger.default.debug(_objectSpread(_objectSpread({}, updatedOptions), {}, {
                 data: hasParams ? "payload keys: ".concat(Object.keys(params).join(', ')) : '(none)',
                 headers: _objectSpread(_objectSpread({}, headers), {}, {
@@ -299,14 +236,11 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
                 })
               }));
             }
-
             _context3.next = 24;
             return Api._sendVerbatim(requestPath, verb, updatedOptions);
-
           case 24:
             response = _context3.sent;
             return _context3.abrupt("return", Api._autoPaginate(path, verb, params, updatedOptions, response, metadata));
-
           case 26:
           case "end":
             return _context3.stop();
@@ -314,7 +248,6 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
       }
     }, _callee3);
   }));
-
   return function (_x10, _x11) {
     return _ref4.apply(this, arguments);
   };