files.com 1.0.236 → 1.0.238

package/_VERSION

@@ -1 +1 @@
-1.0.236
+1.0.238

package/docs/Errors.md

@@ -63,6 +63,7 @@ These errors are derived from the error groups listed above.
 ### BadRequest_InvalidInputEncodingError
 ### BadRequest_InvalidInterfaceError
 ### BadRequest_InvalidOauthProviderError
+### BadRequest_InvalidPathError
 ### BadRequest_InvalidReturnToUrlError
 ### BadRequest_InvalidUploadOffsetError
 ### BadRequest_InvalidUploadPartGapError

package/docs/models/BundleNotification.md

@@ -7,6 +7,7 @@
   "bundle_id": 1,
   "id": 1,
   "notify_on_registration": true,
+  "notify_on_upload": true,
   "user_id": 1
 }
 ```
@@ -14,6 +15,7 @@
 * `bundle_id` (int64): Bundle ID to notify on
 * `id` (int64): Bundle Notification ID
 * `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
+* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
 * `user_id` (int64): The id of the user to notify.
 
 ---
@@ -57,6 +59,7 @@ await BundleNotification.find(id)
 await BundleNotification.create({
   'user_id': 1,
   'notify_on_registration': true,
+  'notify_on_upload': true,
   'bundle_id': 1,
 })
 ```
@@ -66,10 +69,42 @@ await BundleNotification.create({
 
 * `user_id` (int64): Required - The id of the user to notify.
 * `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
+* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
 * `bundle_id` (int64): Required - Bundle ID to notify on
 
 ---
 
+## Update Bundle Notification
+
+```
+const [bundle_notification] = await BundleNotification.list()
+
+await bundle_notification.update({
+  'notify_on_registration': true,
+  'notify_on_upload': true,
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle Notification ID.
+* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
+* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
+
+### Example Response
+
+```json
+{
+  "bundle_id": 1,
+  "id": 1,
+  "notify_on_registration": true,
+  "notify_on_upload": true,
+  "user_id": 1
+}
+```
+
+---
+
 ## Delete Bundle Notification
 
 ```

package/lib/Api.js

@@ -37,53 +37,51 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(path, verb, options) {
     var isExternal, baseUrl, url, response;
     return _regenerator.default.wrap(function _callee$(_context) {
-      while (1) {
-        switch (_context.prev = _context.next) {
-          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({
-              method: verb,
-              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();
-        }
+      while (1) switch (_context.prev = _context.next) {
+        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({
+            method: verb,
+            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();
       }
     }, _callee, null, [[8, 17]]);
   }));
@@ -106,44 +104,42 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
     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) {
-          case 0:
-            if (!((_options$autoPaginate = options.autoPaginate) !== null && _options$autoPaginate !== void 0 ? _options$autoPaginate : _Files.default.getAutoPaginate())) {
-              _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,
-              page: nextPage
-            });
-            nextMetadata = {
-              autoPaginateCount: (autoPaginateCount || 1) + 1,
-              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();
-        }
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          if (!((_options$autoPaginate = options.autoPaginate) !== null && _options$autoPaginate !== void 0 ? _options$autoPaginate : _Files.default.getAutoPaginate())) {
+            _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,
+            page: nextPage
+          });
+          nextMetadata = {
+            autoPaginateCount: (autoPaginateCount || 1) + 1,
+            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();
       }
     }, _callee2);
   }));
@@ -168,83 +164,81 @@ var Api = /*#__PURE__*/(0, _createClass2.default)(function Api() {
       response,
       _args3 = arguments;
     return _regenerator.default.wrap(function _callee3$(_context3) {
-      while (1) {
-        switch (_context3.prev = _context3.next) {
-          case 0:
-            params = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : null;
-            options = _args3.length > 3 && _args3[3] !== undefined ? _args3[3] : {};
-            metadata = _args3.length > 4 && _args3[4] !== undefined ? _args3[4] : null;
-            headers = _objectSpread(_objectSpread({
-              Accept: 'application/json'
-            }, options.headers), {}, {
-              '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;
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          params = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : null;
+          options = _args3.length > 3 && _args3[3] !== undefined ? _args3[3] : {};
+          metadata = _args3.length > 4 && _args3[4] !== undefined ? _args3[4] : null;
+          headers = _objectSpread(_objectSpread({
+            Accept: 'application/json'
+          }, options.headers), {}, {
+            'User-Agent': _Files.default.getUserAgent()
+          });
+          isExternal = /^[a-zA-Z]+:\/\//.test(path);
+          if (isExternal) {
             _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];
-                  return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
-                });
-                requestPath += path.includes('?') ? '&' : '?';
-                requestPath += pairs.join('&');
-              } else {
-                updatedOptions.data = JSON.stringify(params);
-                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), {}, {
-                  'X-FilesAPI-Key': '<redacted>'
-                })
-              }));
+          }
+          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];
+                return "".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value));
+              });
+              requestPath += path.includes('?') ? '&' : '?';
+              requestPath += pairs.join('&');
+            } else {
+              updatedOptions.data = JSON.stringify(params);
+              headers['Content-Type'] = 'application/json';
             }
-            _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();
-        }
+          }
+          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), {}, {
+                'X-FilesAPI-Key': '<redacted>'
+              })
+            }));
+          }
+          _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();
       }
     }, _callee3);
   }));