files.com 1.2.48 → 1.2.50

package/_VERSION

@@ -1 +1 @@
-1.2.48
+1.2.50

package/docs/models/BundleAction.md

@@ -0,0 +1,58 @@
+# BundleAction
+
+## Example BundleAction Object
+
+```
+{
+  "action": "create",
+  "bundle_registration": {
+    "code": "abc123",
+    "name": "account",
+    "company": "Action Verb",
+    "email": "john.doe@files.com",
+    "ip": "10.1.1.1",
+    "inbox_code": "abc123",
+    "clickwrap_body": "example",
+    "form_field_set_id": 1,
+    "form_field_data": {
+      "key": "example value"
+    },
+    "bundle_code": "example",
+    "bundle_id": 1,
+    "bundle_recipient_id": 1,
+    "created_at": "2000-01-01T01:00:00Z"
+  },
+  "when": "2000-01-01T01:00:00Z",
+  "destination": "/to_path",
+  "path": "",
+  "source": "/from_path"
+}
+```
+
+* `action` (string): Type of action
+* `bundle_registration` (BundleRegistration): Object that contains bundle registration information
+* `when` (date-time): Action occurrence date/time
+* `destination` (string): The destination path for this bundle action, if applicable
+* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `source` (string): The source path for this bundle action, if applicable
+
+---
+
+## List Bundle Actions
+
+```
+await BundleAction.list({
+  'per_page': 1,
+  'bundle_id': 1,
+  'bundle_registration_id': 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).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
+* `bundle_id` (int64): Bundle ID
+* `bundle_registration_id` (int64): BundleRegistration ID

package/docs/models/ExavaultApiRequestLog.md

@@ -13,6 +13,7 @@
   "error_message": "example",
   "user_agent": "example",
   "response_code": 1,
+  "success": true,
   "duration_ms": 1
 }
 ```
@@ -26,6 +27,7 @@
 * `error_message` (string): Error message, if applicable
 * `user_agent` (string): User-Agent
 * `response_code` (int64): HTTP Response Code
+* `success` (boolean): `false` if HTTP Response Code is 4xx or 5xx
 * `duration_ms` (int64): Duration (in milliseconds)
 
 ---

package/lib/Files.js

@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
 var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
-var version = '1.2.48';
+var version = '1.2.50';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/BundleAction.js

@@ -0,0 +1,135 @@
+"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 _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+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 _utils = require("../utils");
+var _BundleAction;
+/* eslint-disable no-unused-vars */
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/* eslint-enable no-unused-vars */
+/**
+ * Class BundleAction
+ */
+var BundleAction = /*#__PURE__*/(0, _createClass2.default)(function BundleAction() {
+  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, BundleAction);
+  (0, _defineProperty2.default)(this, "attributes", {});
+  (0, _defineProperty2.default)(this, "options", {});
+  (0, _defineProperty2.default)(this, "isLoaded", function () {
+    return !!_this.attributes.id;
+  });
+  // string # Type of action
+  (0, _defineProperty2.default)(this, "getAction", function () {
+    return _this.attributes.action;
+  });
+  // BundleRegistration # Object that contains bundle registration information
+  (0, _defineProperty2.default)(this, "getBundleRegistration", function () {
+    return _this.attributes.bundle_registration;
+  });
+  // date-time # Action occurrence date/time
+  (0, _defineProperty2.default)(this, "getWhen", function () {
+    return _this.attributes.when;
+  });
+  // string # The destination path for this bundle action, if applicable
+  (0, _defineProperty2.default)(this, "getDestination", function () {
+    return _this.attributes.destination;
+  });
+  // string # 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;
+  });
+  // string # The source path for this bundle action, if applicable
+  (0, _defineProperty2.default)(this, "getSource", function () {
+    return _this.attributes.source;
+  });
+  Object.entries(attributes).forEach(function (_ref) {
+    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+      key = _ref2[0],
+      value = _ref2[1];
+    var normalizedKey = key.replace('?', '');
+    _this.attributes[normalizedKey] = value;
+    Object.defineProperty(_this, normalizedKey, {
+      value: value,
+      writable: false
+    });
+  });
+  this.options = _objectSpread({}, options);
+});
+_BundleAction = BundleAction;
+// 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).
+//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
+//   bundle_id - int64 - Bundle ID
+//   bundle_registration_id - int64 - BundleRegistration ID
+(0, _defineProperty2.default)(BundleAction, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+  var _response$data;
+  var params,
+    options,
+    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] : {};
+        options = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
+        if (!(params.cursor && !(0, _utils.isString)(params.cursor))) {
+          _context.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))) {
+          _context.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:
+        if (!(params.bundle_id && !(0, _utils.isInt)(params.bundle_id))) {
+          _context.next = 8;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: bundle_id must be of type Int, received ".concat((0, _utils.getType)(params.bundle_id)));
+      case 8:
+        if (!(params.bundle_registration_id && !(0, _utils.isInt)(params.bundle_registration_id))) {
+          _context.next = 10;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: bundle_registration_id must be of type Int, received ".concat((0, _utils.getType)(params.bundle_registration_id)));
+      case 10:
+        _context.next = 12;
+        return _Api.default.sendRequest('/bundle_actions', 'GET', params, options);
+      case 12:
+        response = _context.sent;
+        return _context.abrupt("return", (response === null || response === void 0 || (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.map(function (obj) {
+          return new _BundleAction(obj, options);
+        })) || []);
+      case 14:
+      case "end":
+        return _context.stop();
+    }
+  }, _callee);
+})));
+(0, _defineProperty2.default)(BundleAction, "all", function () {
+  var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return _BundleAction.list(params, options);
+});
+var _default = exports.default = BundleAction;
+module.exports = BundleAction;
+module.exports.default = BundleAction;

package/lib/models/ExavaultApiRequestLog.js

@@ -69,6 +69,10 @@ var ExavaultApiRequestLog = /*#__PURE__*/(0, _createClass2.default)(function Exa
   (0, _defineProperty2.default)(this, "getResponseCode", function () {
     return _this.attributes.response_code;
   });
+  // boolean # `false` if HTTP Response Code is 4xx or 5xx
+  (0, _defineProperty2.default)(this, "getSuccess", function () {
+    return _this.attributes.success;
+  });
   // int64 # Duration (in milliseconds)
   (0, _defineProperty2.default)(this, "getDurationMs", function () {
     return _this.attributes.duration_ms;

package/package.json

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

package/src/Files.js

@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
 let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
-const version = '1.2.48'
+const version = '1.2.50'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/BundleAction.js

@@ -0,0 +1,84 @@
+/* eslint-disable no-unused-vars */
+import Api from '../Api'
+import * as errors from '../Errors'
+import {
+  getType, isArray, isInt, isObject, isString,
+} from '../utils'
+/* eslint-enable no-unused-vars */
+
+/**
+ * Class BundleAction
+ */
+class BundleAction {
+  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
+
+  // string # Type of action
+  getAction = () => this.attributes.action
+
+  // BundleRegistration # Object that contains bundle registration information
+  getBundleRegistration = () => this.attributes.bundle_registration
+
+  // date-time # Action occurrence date/time
+  getWhen = () => this.attributes.when
+
+  // string # The destination path for this bundle action, if applicable
+  getDestination = () => this.attributes.destination
+
+  // string # Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+  getPath = () => this.attributes.path
+
+  // string # The source path for this bundle action, if applicable
+  getSource = () => this.attributes.source
+
+  // 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).
+  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
+  //   bundle_id - int64 - Bundle ID
+  //   bundle_registration_id - int64 - BundleRegistration ID
+  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)}`)
+    }
+
+    if (params.bundle_id && !isInt(params.bundle_id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: bundle_id must be of type Int, received ${getType(params.bundle_id)}`)
+    }
+
+    if (params.bundle_registration_id && !isInt(params.bundle_registration_id)) {
+      throw new errors.InvalidParameterError(`Bad parameter: bundle_registration_id must be of type Int, received ${getType(params.bundle_registration_id)}`)
+    }
+
+    const response = await Api.sendRequest('/bundle_actions', 'GET', params, options)
+
+    return response?.data?.map(obj => new BundleAction(obj, options)) || []
+  }
+
+  static all = (params = {}, options = {}) =>
+    BundleAction.list(params, options)
+}
+
+export default BundleAction
+
+module.exports = BundleAction
+module.exports.default = BundleAction

package/src/models/ExavaultApiRequestLog.js

@@ -55,6 +55,9 @@ class ExavaultApiRequestLog {
   // int64 # HTTP Response Code
   getResponseCode = () => this.attributes.response_code
 
+  // boolean # `false` if HTTP Response Code is 4xx or 5xx
+  getSuccess = () => this.attributes.success
+
   // int64 # Duration (in milliseconds)
   getDurationMs = () => this.attributes.duration_ms