files.com 1.2.172 → 1.2.174

package/docs/models/Export.md

@@ -1,76 +0,0 @@
-# Export
-
-## Example Export Object
-
-```
-{
-  "id": 1,
-  "export_status": "example",
-  "export_type": "example",
-  "export_rows": 1,
-  "download_uri": "example",
-  "message": "example"
-}
-```
-
-* `id` (int64): ID for this Export
-* `export_status` (string): Status of the Export
-* `export_type` (string): Type of data being exported
-* `export_rows` (int64): Number of rows exported
-* `download_uri` (string): Link to download Export file.
-* `message` (string): Export message
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
-
----
-
-## List Exports
-
-```
-await Export.list({
-  'user_id': 1,
-})
-```
-
-
-### Parameters
-
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `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. Valid fields are `export_status` and `export_type`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
-
----
-
-## Show Export
-
-```
-await Export.find(id)
-```
-
-
-### Parameters
-
-* `id` (int64): Required - Export ID.
-
----
-
-## Create an export CSV of Export resources
-
-```
-await Export.create({
-  'user_id': 1,
-})
-```
-
-
-### Parameters
-
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.

package/lib/models/Export.js

@@ -1,283 +0,0 @@
-"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 _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 _Api = _interopRequireDefault(require("../Api"));
-var errors = _interopRequireWildcard(require("../Errors"));
-var _utils = require("../utils");
-var _Export;
-/* 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 Export
- */
-var Export = /*#__PURE__*/(0, _createClass2.default)(function Export() {
-  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, Export);
-  (0, _defineProperty2.default)(this, "attributes", {});
-  (0, _defineProperty2.default)(this, "options", {});
-  (0, _defineProperty2.default)(this, "isLoaded", function () {
-    return !!_this.attributes.id;
-  });
-  // int64 # ID for this Export
-  (0, _defineProperty2.default)(this, "getId", function () {
-    return _this.attributes.id;
-  });
-  (0, _defineProperty2.default)(this, "setId", function (value) {
-    _this.attributes.id = value;
-  });
-  // string # Status of the Export
-  (0, _defineProperty2.default)(this, "getExportStatus", function () {
-    return _this.attributes.export_status;
-  });
-  (0, _defineProperty2.default)(this, "setExportStatus", function (value) {
-    _this.attributes.export_status = value;
-  });
-  // string # Type of data being exported
-  (0, _defineProperty2.default)(this, "getExportType", function () {
-    return _this.attributes.export_type;
-  });
-  (0, _defineProperty2.default)(this, "setExportType", function (value) {
-    _this.attributes.export_type = value;
-  });
-  // int64 # Number of rows exported
-  (0, _defineProperty2.default)(this, "getExportRows", function () {
-    return _this.attributes.export_rows;
-  });
-  (0, _defineProperty2.default)(this, "setExportRows", function (value) {
-    _this.attributes.export_rows = value;
-  });
-  // string # Link to download Export file.
-  (0, _defineProperty2.default)(this, "getDownloadUri", function () {
-    return _this.attributes.download_uri;
-  });
-  (0, _defineProperty2.default)(this, "setDownloadUri", function (value) {
-    _this.attributes.download_uri = value;
-  });
-  // string # Export message
-  (0, _defineProperty2.default)(this, "getMessage", function () {
-    return _this.attributes.message;
-  });
-  (0, _defineProperty2.default)(this, "setMessage", function (value) {
-    _this.attributes.message = value;
-  });
-  // int64 # User ID.  Provide a value of `0` to operate the current session's user.
-  (0, _defineProperty2.default)(this, "getUserId", function () {
-    return _this.attributes.user_id;
-  });
-  (0, _defineProperty2.default)(this, "setUserId", function (value) {
-    _this.attributes.user_id = value;
-  });
-  // object # If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
-  (0, _defineProperty2.default)(this, "getSortBy", function () {
-    return _this.attributes.sort_by;
-  });
-  (0, _defineProperty2.default)(this, "setSortBy", function (value) {
-    _this.attributes.sort_by = value;
-  });
-  // object # If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-  (0, _defineProperty2.default)(this, "getFilter", function () {
-    return _this.attributes.filter;
-  });
-  (0, _defineProperty2.default)(this, "setFilter", function (value) {
-    _this.attributes.filter = value;
-  });
-  // object # If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
-  (0, _defineProperty2.default)(this, "getFilterPrefix", function () {
-    return _this.attributes.filter_prefix;
-  });
-  (0, _defineProperty2.default)(this, "setFilterPrefix", function (value) {
-    _this.attributes.filter_prefix = value;
-  });
-  (0, _defineProperty2.default)(this, "save", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
-    var newObject;
-    return _regenerator.default.wrap(function _callee$(_context) {
-      while (1) switch (_context.prev = _context.next) {
-        case 0:
-          if (!_this.attributes.id) {
-            _context.next = 4;
-            break;
-          }
-          throw new errors.NotImplementedError('The Export object doesn\'t support updates.');
-        case 4:
-          _context.next = 6;
-          return Export.create(_this.attributes, _this.options);
-        case 6:
-          newObject = _context.sent;
-          _this.attributes = _objectSpread({}, newObject.attributes);
-          return _context.abrupt("return", true);
-        case 9:
-        case "end":
-          return _context.stop();
-      }
-    }, _callee);
-  })));
-  Object.entries(attributes).forEach(function (_ref2) {
-    var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
-      key = _ref3[0],
-      value = _ref3[1];
-    var normalizedKey = key.replace('?', '');
-    _this.attributes[normalizedKey] = value;
-    Object.defineProperty(_this, normalizedKey, {
-      value: value,
-      writable: false
-    });
-  });
-  this.options = _objectSpread({}, options);
-});
-_Export = Export;
-// Parameters:
-//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
-//   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. Valid fields are `export_status` and `export_type`.
-//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-//   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
-(0, _defineProperty2.default)(Export, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee2() {
-  var _response$data;
-  var params,
-    options,
-    response,
-    _args2 = arguments;
-  return _regenerator.default.wrap(function _callee2$(_context2) {
-    while (1) switch (_context2.prev = _context2.next) {
-      case 0:
-        params = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
-        options = _args2.length > 1 && _args2[1] !== undefined ? _args2[1] : {};
-        if (!(params.user_id && !(0, _utils.isInt)(params.user_id))) {
-          _context2.next = 4;
-          break;
-        }
-        throw new errors.InvalidParameterError("Bad parameter: user_id must be of type Int, received ".concat((0, _utils.getType)(params.user_id)));
-      case 4:
-        if (!(params.cursor && !(0, _utils.isString)(params.cursor))) {
-          _context2.next = 6;
-          break;
-        }
-        throw new errors.InvalidParameterError("Bad parameter: cursor must be of type String, received ".concat((0, _utils.getType)(params.cursor)));
-      case 6:
-        if (!(params.per_page && !(0, _utils.isInt)(params.per_page))) {
-          _context2.next = 8;
-          break;
-        }
-        throw new errors.InvalidParameterError("Bad parameter: per_page must be of type Int, received ".concat((0, _utils.getType)(params.per_page)));
-      case 8:
-        _context2.next = 10;
-        return _Api.default.sendRequest('/exports', 'GET', params, options);
-      case 10:
-        response = _context2.sent;
-        return _context2.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 _Export(obj, options);
-        })) || []);
-      case 12:
-      case "end":
-        return _context2.stop();
-    }
-  }, _callee2);
-})));
-(0, _defineProperty2.default)(Export, "all", function () {
-  var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  return _Export.list(params, options);
-});
-// Parameters:
-//   id (required) - int64 - Export ID.
-(0, _defineProperty2.default)(Export, "find", /*#__PURE__*/function () {
-  var _ref5 = (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee3(id) {
-    var params,
-      options,
-      response,
-      _args3 = arguments;
-    return _regenerator.default.wrap(function _callee3$(_context3) {
-      while (1) switch (_context3.prev = _context3.next) {
-        case 0:
-          params = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : {};
-          options = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : {};
-          if ((0, _utils.isObject)(params)) {
-            _context3.next = 4;
-            break;
-          }
-          throw new errors.InvalidParameterError("Bad parameter: params must be of type object, received ".concat((0, _utils.getType)(params)));
-        case 4:
-          params.id = id;
-          if (params.id) {
-            _context3.next = 7;
-            break;
-          }
-          throw new errors.MissingParameterError('Parameter missing: id');
-        case 7:
-          if (!(params.id && !(0, _utils.isInt)(params.id))) {
-            _context3.next = 9;
-            break;
-          }
-          throw new errors.InvalidParameterError("Bad parameter: id must be of type Int, received ".concat((0, _utils.getType)(params.id)));
-        case 9:
-          _context3.next = 11;
-          return _Api.default.sendRequest("/exports/".concat(encodeURIComponent(params.id)), 'GET', params, options);
-        case 11:
-          response = _context3.sent;
-          return _context3.abrupt("return", new _Export(response === null || response === void 0 ? void 0 : response.data, options));
-        case 13:
-        case "end":
-          return _context3.stop();
-      }
-    }, _callee3);
-  }));
-  return function (_x) {
-    return _ref5.apply(this, arguments);
-  };
-}());
-(0, _defineProperty2.default)(Export, "get", function (id) {
-  var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-  return _Export.find(id, params, options);
-});
-// Parameters:
-//   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
-//   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
-//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-//   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
-(0, _defineProperty2.default)(Export, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
-  var params,
-    options,
-    response,
-    _args4 = arguments;
-  return _regenerator.default.wrap(function _callee4$(_context4) {
-    while (1) switch (_context4.prev = _context4.next) {
-      case 0:
-        params = _args4.length > 0 && _args4[0] !== undefined ? _args4[0] : {};
-        options = _args4.length > 1 && _args4[1] !== undefined ? _args4[1] : {};
-        if (!(params.user_id && !(0, _utils.isInt)(params.user_id))) {
-          _context4.next = 4;
-          break;
-        }
-        throw new errors.InvalidParameterError("Bad parameter: user_id must be of type Int, received ".concat((0, _utils.getType)(params.user_id)));
-      case 4:
-        _context4.next = 6;
-        return _Api.default.sendRequest('/exports/create_export', 'POST', params, options);
-      case 6:
-        response = _context4.sent;
-        return _context4.abrupt("return", new _Export(response === null || response === void 0 ? void 0 : response.data, options));
-      case 8:
-      case "end":
-        return _context4.stop();
-    }
-  }, _callee4);
-})));
-var _default = exports.default = Export;
-module.exports = Export;
-module.exports.default = Export;

package/src/models/Export.js

@@ -1,183 +0,0 @@
-/* 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 Export
- */
-class Export {
-  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 for this Export
-  getId = () => this.attributes.id
-
-  setId = value => {
-    this.attributes.id = value
-  }
-
-  // string # Status of the Export
-  getExportStatus = () => this.attributes.export_status
-
-  setExportStatus = value => {
-    this.attributes.export_status = value
-  }
-
-  // string # Type of data being exported
-  getExportType = () => this.attributes.export_type
-
-  setExportType = value => {
-    this.attributes.export_type = value
-  }
-
-  // int64 # Number of rows exported
-  getExportRows = () => this.attributes.export_rows
-
-  setExportRows = value => {
-    this.attributes.export_rows = value
-  }
-
-  // string # Link to download Export file.
-  getDownloadUri = () => this.attributes.download_uri
-
-  setDownloadUri = value => {
-    this.attributes.download_uri = value
-  }
-
-  // string # Export message
-  getMessage = () => this.attributes.message
-
-  setMessage = value => {
-    this.attributes.message = value
-  }
-
-  // int64 # User ID.  Provide a value of `0` to operate the current session's user.
-  getUserId = () => this.attributes.user_id
-
-  setUserId = value => {
-    this.attributes.user_id = value
-  }
-
-  // object # If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
-  getSortBy = () => this.attributes.sort_by
-
-  setSortBy = value => {
-    this.attributes.sort_by = value
-  }
-
-  // object # If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-  getFilter = () => this.attributes.filter
-
-  setFilter = value => {
-    this.attributes.filter = value
-  }
-
-  // object # If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
-  getFilterPrefix = () => this.attributes.filter_prefix
-
-  setFilterPrefix = value => {
-    this.attributes.filter_prefix = value
-  }
-
-  save = async () => {
-    if (this.attributes.id) {
-      throw new errors.NotImplementedError('The Export object doesn\'t support updates.')
-    } else {
-      const newObject = await Export.create(this.attributes, this.options)
-      this.attributes = { ...newObject.attributes }
-      return true
-    }
-  }
-
-  // Parameters:
-  //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
-  //   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. Valid fields are `export_status` and `export_type`.
-  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-  //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
-  static list = async (params = {}, options = {}) => {
-    if (params.user_id && !isInt(params.user_id)) {
-      throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params.user_id)}`)
-    }
-
-    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('/exports', 'GET', params, options)
-
-    return response?.data?.map(obj => new Export(obj, options)) || []
-  }
-
-  static all = (params = {}, options = {}) =>
-    Export.list(params, options)
-
-  // Parameters:
-  //   id (required) - int64 - Export ID.
-  static find = async (id, params = {}, options = {}) => {
-    if (!isObject(params)) {
-      throw new errors.InvalidParameterError(`Bad parameter: params must be of type object, received ${getType(params)}`)
-    }
-
-    params.id = id
-
-    if (!params.id) {
-      throw new errors.MissingParameterError('Parameter missing: id')
-    }
-
-    if (params.id && !isInt(params.id)) {
-      throw new errors.InvalidParameterError(`Bad parameter: id must be of type Int, received ${getType(params.id)}`)
-    }
-
-    const response = await Api.sendRequest(`/exports/${encodeURIComponent(params.id)}`, 'GET', params, options)
-
-    return new Export(response?.data, options)
-  }
-
-  static get = (id, params = {}, options = {}) =>
-    Export.find(id, params, options)
-
-  // Parameters:
-  //   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
-  //   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
-  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
-  //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
-  static create = async (params = {}, options = {}) => {
-    if (params.user_id && !isInt(params.user_id)) {
-      throw new errors.InvalidParameterError(`Bad parameter: user_id must be of type Int, received ${getType(params.user_id)}`)
-    }
-
-    const response = await Api.sendRequest('/exports/create_export', 'POST', params, options)
-
-    return new Export(response?.data, options)
-  }
-}
-
-export default Export
-
-module.exports = Export
-module.exports.default = Export