files.com 1.0.296 → 1.0.298

package/_VERSION

@@ -1 +1 @@
-1.0.296
+1.0.298

package/docs/models/Automation.md

@@ -8,7 +8,7 @@
   "automation": "create_folder",
   "deleted": true,
   "disabled": true,
-  "trigger": "realtime",
+  "trigger": "daily",
   "interval": "week",
   "last_modified_at": "2000-01-01T01:00:00Z",
   "name": "example",
@@ -49,13 +49,13 @@
 * `automation` (string): Automation type
 * `deleted` (boolean): Indicates if the automation has been deleted.
 * `disabled` (boolean): If true, this automation will not run.
-* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+* `trigger` (string): How this automation is triggered to run.
 * `interval` (string): If trigger is `daily`, this specifies how often to run this automation.  One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
 * `last_modified_at` (date-time): Time when automation was last modified. Does not change for name or description updates.
 * `name` (string): Name for this automation.
 * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
 * `source` (string): Source Path
-* `destinations` (array): Destination Path
+* `destinations` (array): Destination Paths
 * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
 * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
 * `description` (string): Description for the this Automation.
@@ -126,7 +126,7 @@ await Automation.create({
   'description': "example",
   'disabled': true,
   'name': "example",
-  'trigger': "realtime",
+  'trigger': "daily",
   'trigger_actions': ["create"],
   'value': {"limit":"1"},
   'recurring_day': 25,
@@ -151,7 +151,7 @@ await Automation.create({
 * `description` (string): Description for the this Automation.
 * `disabled` (boolean): If true, this automation will not run.
 * `name` (string): Name for this automation.
-* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+* `trigger` (string): How this automation is triggered to run.
 * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
 * `value` (object): A Hash of attributes specific to the automation type.
 * `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
@@ -193,7 +193,7 @@ await automation.update({
   'description': "example",
   'disabled': true,
   'name': "example",
-  'trigger': "realtime",
+  'trigger': "daily",
   'trigger_actions': ["create"],
   'value': {"limit":"1"},
   'recurring_day': 25,
@@ -218,7 +218,7 @@ await automation.update({
 * `description` (string): Description for the this Automation.
 * `disabled` (boolean): If true, this automation will not run.
 * `name` (string): Name for this automation.
-* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+* `trigger` (string): How this automation is triggered to run.
 * `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
 * `value` (object): A Hash of attributes specific to the automation type.
 * `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
@@ -232,7 +232,7 @@ await automation.update({
   "automation": "create_folder",
   "deleted": true,
   "disabled": true,
-  "trigger": "realtime",
+  "trigger": "daily",
   "interval": "week",
   "last_modified_at": "2000-01-01T01:00:00Z",
   "name": "example",

package/docs/models/EmailIncomingMessage.md

@@ -0,0 +1,44 @@
+# EmailIncomingMessage
+
+## Example EmailIncomingMessage Object
+
+```
+{
+  "id": 1,
+  "inbox_id": 1,
+  "sender": "example",
+  "status": "success",
+  "message": "example",
+  "created_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Id of the Email Incoming Message
+* `inbox_id` (int64): Id of the Inbox associated with this message
+* `sender` (string): Sender of the email
+* `status` (string): Status of the message
+* `message` (string): Message describing the failure
+* `created_at` (date-time): Message creation date/time
+
+---
+
+## List Email Incoming Messages
+
+```
+await EmailIncomingMessage.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).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, created_at ]`, `[ inbox_id, status, created_at ]` or `[ inbox_id, status, sender, created_at ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.

package/lib/models/Automation.js

@@ -59,7 +59,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   (0, _defineProperty2.default)(this, "setDisabled", function (value) {
     _this.attributes.disabled = value;
   });
-  // string # How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+  // string # How this automation is triggered to run.
   (0, _defineProperty2.default)(this, "getTrigger", function () {
     return _this.attributes.trigger;
   });
@@ -101,7 +101,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   (0, _defineProperty2.default)(this, "setSource", function (value) {
     _this.attributes.source = value;
   });
-  // array # Destination Path
+  // array # Destination Paths
   (0, _defineProperty2.default)(this, "getDestinations", function () {
     return _this.attributes.destinations;
   });
@@ -267,7 +267,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   //   description - string - Description for the this Automation.
   //   disabled - boolean - If true, this automation will not run.
   //   name - string - Name for this automation.
-  //   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+  //   trigger - string - How this automation is triggered to run.
   //   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
   //   value - object - A Hash of attributes specific to the automation type.
   //   recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
@@ -616,7 +616,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
 //   description - string - Description for the this Automation.
 //   disabled - boolean - If true, this automation will not run.
 //   name - string - Name for this automation.
-//   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+//   trigger - string - How this automation is triggered to run.
 //   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
 //   value - object - A Hash of attributes specific to the automation type.
 //   recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.

package/lib/models/EmailIncomingMessage.js

@@ -0,0 +1,123 @@
+"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 _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 EmailIncomingMessage
+ */
+var EmailIncomingMessage = /*#__PURE__*/(0, _createClass2.default)(function EmailIncomingMessage() {
+  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, EmailIncomingMessage);
+  (0, _defineProperty2.default)(this, "attributes", {});
+  (0, _defineProperty2.default)(this, "options", {});
+  (0, _defineProperty2.default)(this, "isLoaded", function () {
+    return !!_this.attributes.id;
+  });
+  // int64 # Id of the Email Incoming Message
+  (0, _defineProperty2.default)(this, "getId", function () {
+    return _this.attributes.id;
+  });
+  // int64 # Id of the Inbox associated with this message
+  (0, _defineProperty2.default)(this, "getInboxId", function () {
+    return _this.attributes.inbox_id;
+  });
+  // string # Sender of the email
+  (0, _defineProperty2.default)(this, "getSender", function () {
+    return _this.attributes.sender;
+  });
+  // string # Status of the message
+  (0, _defineProperty2.default)(this, "getStatus", function () {
+    return _this.attributes.status;
+  });
+  // string # Message describing the failure
+  (0, _defineProperty2.default)(this, "getMessage", function () {
+    return _this.attributes.message;
+  });
+  // date-time # Message creation date/time
+  (0, _defineProperty2.default)(this, "getCreatedAt", function () {
+    return _this.attributes.created_at;
+  });
+  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);
+});
+// 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[created_at]=desc`). Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, created_at ]`, `[ inbox_id, status, created_at ]` or `[ inbox_id, status, sender, created_at ]`.
+//   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+//   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+//   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
+//   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+//   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
+(0, _defineProperty2.default)(EmailIncomingMessage, "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:
+        _context.next = 8;
+        return _Api.default.sendRequest("/email_incoming_messages", 'GET', params, options);
+      case 8:
+        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 EmailIncomingMessage(obj, options);
+        })) || []);
+      case 10:
+      case "end":
+        return _context.stop();
+    }
+  }, _callee);
+})));
+(0, _defineProperty2.default)(EmailIncomingMessage, "all", function () {
+  var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  return EmailIncomingMessage.list(params, options);
+});
+var _default = EmailIncomingMessage;
+exports.default = _default;

package/package.json

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

package/src/models/Automation.js

@@ -51,7 +51,7 @@ class Automation {
     this.attributes.disabled = value
   }
 
-  // string # How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+  // string # How this automation is triggered to run.
   getTrigger = () => this.attributes.trigger
 
   setTrigger = value => {
@@ -93,7 +93,7 @@ class Automation {
     this.attributes.source = value
   }
 
-  // array # Destination Path
+  // array # Destination Paths
   getDestinations = () => this.attributes.destinations
 
   setDestinations = value => {
@@ -235,7 +235,7 @@ class Automation {
   //   description - string - Description for the this Automation.
   //   disabled - boolean - If true, this automation will not run.
   //   name - string - Name for this automation.
-  //   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+  //   trigger - string - How this automation is triggered to run.
   //   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
   //   value - object - A Hash of attributes specific to the automation type.
   //   recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
@@ -422,7 +422,7 @@ class Automation {
   //   description - string - Description for the this Automation.
   //   disabled - boolean - If true, this automation will not run.
   //   name - string - Name for this automation.
-  //   trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
+  //   trigger - string - How this automation is triggered to run.
   //   trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
   //   value - object - A Hash of attributes specific to the automation type.
   //   recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.

package/src/models/EmailIncomingMessage.js

@@ -0,0 +1,73 @@
+import Api from '../Api'
+import * as errors from '../Errors'
+import Logger from '../Logger'
+import { getType, isArray, isBrowser, isInt, isObject, isString } from '../utils'
+
+/**
+ * Class EmailIncomingMessage
+ */
+class EmailIncomingMessage {
+  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
+  // int64 # Id of the Email Incoming Message
+  getId = () => this.attributes.id
+
+  // int64 # Id of the Inbox associated with this message
+  getInboxId = () => this.attributes.inbox_id
+
+  // string # Sender of the email
+  getSender = () => this.attributes.sender
+
+  // string # Status of the message
+  getStatus = () => this.attributes.status
+
+  // string # Message describing the failure
+  getMessage = () => this.attributes.message
+
+  // date-time # Message creation date/time
+  getCreatedAt = () => this.attributes.created_at
+
+
+  // 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[created_at]=desc`). Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
+  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, created_at ]`, `[ inbox_id, status, created_at ]` or `[ inbox_id, status, sender, created_at ]`.
+  //   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+  //   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+  //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
+  //   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+  //   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
+  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(`/email_incoming_messages`, 'GET', params, options)
+
+    return response?.data?.map(obj => new EmailIncomingMessage(obj, options)) || []
+  }
+
+  static all = (params = {}, options = {}) =>
+    EmailIncomingMessage.list(params, options)
+}
+
+export default EmailIncomingMessage