files.com 1.2.271 → 1.2.272

package/_VERSION

@@ -1 +1 @@
-1.2.271
+1.2.272

package/docs/models/Automation.md

@@ -86,7 +86,8 @@
   "value": {
     "limit": "1"
   },
-  "webhook_url": "https://app.files.com/api/webhooks/abc123"
+  "webhook_url": "https://app.files.com/api/webhooks/abc123",
+  "holiday_region": "us_dc"
 }
 ```
 
@@ -128,6 +129,7 @@
 * `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
 * `value` (object): A Hash of attributes specific to the automation type.
 * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
+* `holiday_region` (string): If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
 
 ---
 
@@ -415,7 +417,8 @@ await automation.update({
   "value": {
     "limit": "1"
   },
-  "webhook_url": "https://app.files.com/api/webhooks/abc123"
+  "webhook_url": "https://app.files.com/api/webhooks/abc123",
+  "holiday_region": "us_dc"
 }
 ```
 

package/docs/models/HolidayRegion.md

@@ -0,0 +1,27 @@
+# HolidayRegion
+
+## Example HolidayRegion Object
+
+```
+{
+  "code": "us_dc",
+  "name": "United States - District of Columbia"
+}
+```
+
+* `code` (string): The code representing a region
+* `name` (string): The name of the region
+
+---
+
+## List all possible holiday regions
+
+```
+await HolidayRegion.getSupported
+```
+
+
+### 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).

package/docs/models/Sync.md

@@ -39,7 +39,8 @@
     "06:30",
     "14:30"
   ],
-  "schedule_time_zone": "Eastern Time (US & Canada)"
+  "schedule_time_zone": "Eastern Time (US & Canada)",
+  "holiday_region": "us_dc"
 }
 ```
 
@@ -68,6 +69,7 @@
 * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
 * `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
 * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
+* `holiday_region` (string): If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
 
 ---
 
@@ -255,7 +257,8 @@ await sync.update({
     "06:30",
     "14:30"
   ],
-  "schedule_time_zone": "Eastern Time (US & Canada)"
+  "schedule_time_zone": "Eastern Time (US & Canada)",
+  "holiday_region": "us_dc"
 }
 ```
 

package/lib/Files.js

@@ -12,7 +12,7 @@ var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
 var language = null;
-var version = '1.2.271';
+var version = '1.2.272';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/Automation.js

@@ -298,6 +298,13 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
   (0, _defineProperty2.default)(this, "setWebhookUrl", function (value) {
     _this.attributes.webhook_url = value;
   });
+  // string # If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
+  (0, _defineProperty2.default)(this, "getHolidayRegion", function () {
+    return _this.attributes.holiday_region;
+  });
+  (0, _defineProperty2.default)(this, "setHolidayRegion", function (value) {
+    _this.attributes.holiday_region = value;
+  });
   // Manually Run Automation
   (0, _defineProperty2.default)(this, "manualRun", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,

package/lib/models/HolidayRegion.js

@@ -0,0 +1,98 @@
+"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 _HolidayRegion;
+/* eslint-disable no-unused-vars */
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+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 HolidayRegion
+ */
+var HolidayRegion = /*#__PURE__*/(0, _createClass2.default)(function HolidayRegion() {
+  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, HolidayRegion);
+  (0, _defineProperty2.default)(this, "attributes", {});
+  (0, _defineProperty2.default)(this, "options", {});
+  (0, _defineProperty2.default)(this, "isLoaded", function () {
+    return !!_this.attributes.id;
+  });
+  // string # The code representing a region
+  (0, _defineProperty2.default)(this, "getCode", function () {
+    return _this.attributes.code;
+  });
+  // string # The name of the region
+  (0, _defineProperty2.default)(this, "getName", function () {
+    return _this.attributes.name;
+  });
+  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);
+});
+_HolidayRegion = HolidayRegion;
+// 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)(HolidayRegion, "getSupported", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
+  var _response$data;
+  var params,
+    options,
+    response,
+    _args = arguments;
+  return _regenerator.default.wrap(function (_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 = 1;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: cursor must be of type String, received ".concat((0, _utils.getType)(params.cursor)));
+      case 1:
+        if (!(params.per_page && !(0, _utils.isInt)(params.per_page))) {
+          _context.next = 2;
+          break;
+        }
+        throw new errors.InvalidParameterError("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(params.per_page)));
+      case 2:
+        _context.next = 3;
+        return _Api.default.sendRequest('/holiday_regions/supported', 'GET', params, options);
+      case 3:
+        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 _HolidayRegion(obj, options);
+        })) || []);
+      case 4:
+      case "end":
+        return _context.stop();
+    }
+  }, _callee);
+})));
+var _default = exports.default = HolidayRegion;
+module.exports = HolidayRegion;
+module.exports.default = HolidayRegion;

package/lib/models/Sync.js

@@ -201,6 +201,13 @@ var Sync = /*#__PURE__*/(0, _createClass2.default)(function Sync() {
   (0, _defineProperty2.default)(this, "setScheduleTimeZone", function (value) {
     _this.attributes.schedule_time_zone = value;
   });
+  // string # If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
+  (0, _defineProperty2.default)(this, "getHolidayRegion", function () {
+    return _this.attributes.holiday_region;
+  });
+  (0, _defineProperty2.default)(this, "setHolidayRegion", function (value) {
+    _this.attributes.holiday_region = value;
+  });
   // Manually Run Sync
   (0, _defineProperty2.default)(this, "manualRun", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,

package/package.json

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

package/src/Files.js

@@ -6,7 +6,7 @@ let apiKey
 let baseUrl = 'https://app.files.com'
 let sessionId = null
 let language = null
-const version = '1.2.271'
+const version = '1.2.272'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/Automation.js

@@ -294,6 +294,13 @@ class Automation {
     this.attributes.webhook_url = value
   }
 
+  // string # If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
+  getHolidayRegion = () => this.attributes.holiday_region
+
+  setHolidayRegion = value => {
+    this.attributes.holiday_region = value
+  }
+
   // Manually Run Automation
   manualRun = async (params = {}) => {
     if (!this.attributes.id) {

package/src/models/HolidayRegion.js

@@ -0,0 +1,58 @@
+/* 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 HolidayRegion
+ */
+class HolidayRegion {
+  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 # The code representing a region
+  getCode = () => this.attributes.code
+
+  // string # The name of the region
+  getName = () => this.attributes.name
+
+  // 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 getSupported = 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('/holiday_regions/supported', 'GET', params, options)
+
+    return response?.data?.map(obj => new HolidayRegion(obj, options)) || []
+  }
+}
+
+export default HolidayRegion
+
+module.exports = HolidayRegion
+module.exports.default = HolidayRegion

package/src/models/Sync.js

@@ -195,6 +195,13 @@ class Sync {
     this.attributes.schedule_time_zone = value
   }
 
+  // string # If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
+  getHolidayRegion = () => this.attributes.holiday_region
+
+  setHolidayRegion = value => {
+    this.attributes.holiday_region = value
+  }
+
   // Manually Run Sync
   manualRun = async (params = {}) => {
     if (!this.attributes.id) {