files.com 1.2.556 → 1.2.558

package/_VERSION

@@ -1 +1 @@
-1.2.556
+1.2.558

package/docs/models/AutomationRun.md

@@ -54,7 +54,7 @@ await AutomationRun.list({
 * `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 `automation_id`, `created_at` or `status`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
 * `automation_id` (int64): Required - ID of the associated Automation.
 
 ---

package/docs/models/Bundle.md

@@ -154,7 +154,7 @@ await Bundle.list({
 * `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 `expires_at`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
 * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_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` and `expires_at`.
 * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

package/docs/models/PartnerSite.md

@@ -6,13 +6,28 @@
 {
   "partner_id": 1,
   "partner_name": "Acme Corp",
-  "linked_site_id": 1
+  "linked_site_id": 1,
+  "linked_site_name": "Acme's Partner Site",
+  "main_site_id": 2,
+  "main_site_name": "Acme Site"
 }
 ```
 
 * `partner_id` (int64): Partner ID
 * `partner_name` (string): Partner Name
 * `linked_site_id` (int64): Linked Site ID
+* `linked_site_name` (string): Linked Site Name
+* `main_site_id` (int64): Main Site ID
+* `main_site_name` (string): Main Site Name
+
+---
+
+## Get Partner Sites linked to the current Site
+
+```
+await PartnerSite.linkeds
+```
+
 
 ---
 

package/docs/models/PartnerSiteRequest.md

@@ -8,6 +8,7 @@
   "partner_id": 1,
   "linked_site_id": 1,
   "status": "pending",
+  "main_site_name": "Acme Site",
   "pairing_key": "abc123xyz",
   "created_at": "2000-01-01T01:00:00Z",
   "updated_at": "2000-01-01T01:00:00Z"
@@ -18,6 +19,7 @@
 * `partner_id` (int64): Partner ID
 * `linked_site_id` (int64): Linked Site ID
 * `status` (string): Request status (pending, approved, rejected)
+* `main_site_name` (string): Main Site Name
 * `pairing_key` (string): Pairing key used to approve this request on the target site
 * `created_at` (date-time): Request creation date/time
 * `updated_at` (date-time): Request last updated date/time

package/docs/models/User.md

@@ -184,7 +184,7 @@ await User.list({
 * `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 `site_id`, `workspace_id`, `company`, `name`, `disabled`, `authenticate_until`, `username`, `email`, `last_desktop_login_at`, `last_login_at`, `site_admin`, `password_validity_days` or `ssl_required`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled`, `partner_id` or `workspace_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]`, `[ workspace_id, username ]`, `[ company, name ]`, `[ workspace_id, name ]`, `[ workspace_id, email ]`, `[ workspace_id, company ]`, `[ workspace_id, disabled ]`, `[ workspace_id, disabled, username ]` or `[ workspace_id, company, name ]`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled`, `partner_id` or `workspace_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]`, `[ workspace_id, username ]`, `[ company, name ]`, `[ workspace_id, name ]`, `[ workspace_id, email ]`, `[ workspace_id, company ]`, `[ workspace_id, disabled ]`, `[ workspace_id, partner_id ]`, `[ workspace_id, disabled, username ]`, `[ workspace_id, partner_id, username ]` or `[ workspace_id, company, name ]`.
 * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
 * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
 * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.

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.556';
+var version = '1.2.558';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;

package/lib/models/AutomationRun.js

@@ -107,7 +107,7 @@ _AutomationRun = AutomationRun;
 //   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 `automation_id`, `created_at` or `status`.
-//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
 //   automation_id (required) - int64 - ID of the associated Automation.
 (0, _defineProperty2.default)(AutomationRun, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;

package/lib/models/Bundle.js

@@ -699,7 +699,7 @@ _Bundle = Bundle;
 //   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 `expires_at`.
-//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
 //   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_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` and `expires_at`.
 //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

package/lib/models/PartnerSite.js

@@ -44,6 +44,18 @@ var PartnerSite = /*#__PURE__*/(0, _createClass2.default)(function PartnerSite()
   (0, _defineProperty2.default)(this, "getLinkedSiteId", function () {
     return _this.attributes.linked_site_id;
   });
+  // string # Linked Site Name
+  (0, _defineProperty2.default)(this, "getLinkedSiteName", function () {
+    return _this.attributes.linked_site_name;
+  });
+  // int64 # Main Site ID
+  (0, _defineProperty2.default)(this, "getMainSiteId", function () {
+    return _this.attributes.main_site_id;
+  });
+  // string # Main Site Name
+  (0, _defineProperty2.default)(this, "getMainSiteName", function () {
+    return _this.attributes.main_site_name;
+  });
   Object.entries(attributes).forEach(function (_ref) {
     var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
       key = _ref2[0],
@@ -58,44 +70,66 @@ var PartnerSite = /*#__PURE__*/(0, _createClass2.default)(function PartnerSite()
   this.options = _objectSpread({}, options);
 });
 _PartnerSite = PartnerSite;
+(0, _defineProperty2.default)(PartnerSite, "linkeds", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
+  var _response$data;
+  var options,
+    response,
+    _args = arguments;
+  return _regenerator.default.wrap(function (_context) {
+    while (1) switch (_context.prev = _context.next) {
+      case 0:
+        options = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
+        _context.next = 1;
+        return _Api.default.sendRequest('/partner_sites/linked_partner_sites', 'GET', {}, options);
+      case 1:
+        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 _PartnerSite(obj, options);
+        })) || []);
+      case 2:
+      case "end":
+        return _context.stop();
+    }
+  }, _callee);
+})));
 // 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)(PartnerSite, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
-  var _response$data;
+(0, _defineProperty2.default)(PartnerSite, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee2() {
+  var _response$data2;
   var params,
     options,
     response,
-    _args = arguments;
-  return _regenerator.default.wrap(function (_context) {
-    while (1) switch (_context.prev = _context.next) {
+    _args2 = arguments;
+  return _regenerator.default.wrap(function (_context2) {
+    while (1) switch (_context2.prev = _context2.next) {
       case 0:
-        params = _args.length > 0 && _args[0] !== undefined ? _args[0] : {};
-        options = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
+        params = _args2.length > 0 && _args2[0] !== undefined ? _args2[0] : {};
+        options = _args2.length > 1 && _args2[1] !== undefined ? _args2[1] : {};
         if (!(params.cursor && !(0, _utils.isString)(params.cursor))) {
-          _context.next = 1;
+          _context2.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;
+          _context2.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;
+        _context2.next = 3;
         return _Api.default.sendRequest('/partner_sites', '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) {
+        response = _context2.sent;
+        return _context2.abrupt("return", (response === null || response === void 0 || (_response$data2 = response.data) === null || _response$data2 === void 0 ? void 0 : _response$data2.map(function (obj) {
           return new _PartnerSite(obj, options);
         })) || []);
       case 4:
       case "end":
-        return _context.stop();
+        return _context2.stop();
     }
-  }, _callee);
+  }, _callee2);
 })));
 (0, _defineProperty2.default)(PartnerSite, "all", function () {
   var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};

package/lib/models/PartnerSiteRequest.js

@@ -60,6 +60,13 @@ var PartnerSiteRequest = /*#__PURE__*/(0, _createClass2.default)(function Partne
   (0, _defineProperty2.default)(this, "setStatus", function (value) {
     _this.attributes.status = value;
   });
+  // string # Main Site Name
+  (0, _defineProperty2.default)(this, "getMainSiteName", function () {
+    return _this.attributes.main_site_name;
+  });
+  (0, _defineProperty2.default)(this, "setMainSiteName", function (value) {
+    _this.attributes.main_site_name = value;
+  });
   // string # Pairing key used to approve this request on the target site
   (0, _defineProperty2.default)(this, "getPairingKey", function () {
     return _this.attributes.pairing_key;

package/lib/models/User.js

@@ -1164,7 +1164,7 @@ _User = 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 `site_id`, `workspace_id`, `company`, `name`, `disabled`, `authenticate_until`, `username`, `email`, `last_desktop_login_at`, `last_login_at`, `site_admin`, `password_validity_days` or `ssl_required`.
-//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled`, `partner_id` or `workspace_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]`, `[ workspace_id, username ]`, `[ company, name ]`, `[ workspace_id, name ]`, `[ workspace_id, email ]`, `[ workspace_id, company ]`, `[ workspace_id, disabled ]`, `[ workspace_id, disabled, username ]` or `[ workspace_id, company, name ]`.
+//   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled`, `partner_id` or `workspace_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]`, `[ workspace_id, username ]`, `[ company, name ]`, `[ workspace_id, name ]`, `[ workspace_id, email ]`, `[ workspace_id, company ]`, `[ workspace_id, disabled ]`, `[ workspace_id, partner_id ]`, `[ workspace_id, disabled, username ]`, `[ workspace_id, partner_id, username ]` or `[ workspace_id, company, name ]`.
 //   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
 //   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
 //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "files.com",
-  "version": "1.2.556",
+  "version": "1.2.558",
   "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.556'
+const version = '1.2.558'
 let userAgent = `Files.com JavaScript SDK v${version}`
 
 let logLevel = LogLevel.INFO

package/src/models/AutomationRun.js

@@ -75,7 +75,7 @@ class AutomationRun {
   //   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 `automation_id`, `created_at` or `status`.
-  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
+  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
   //   automation_id (required) - int64 - ID of the associated Automation.
   static list = async (params = {}, options = {}) => {
     if (!params.automation_id) {

package/src/models/Bundle.js

@@ -556,7 +556,7 @@ class Bundle {
   //   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 `expires_at`.
-  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
+  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
   //   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_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` and `expires_at`.
   //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

package/src/models/PartnerSite.js

@@ -37,6 +37,21 @@ class PartnerSite {
   // int64 # Linked Site ID
   getLinkedSiteId = () => this.attributes.linked_site_id
 
+  // string # Linked Site Name
+  getLinkedSiteName = () => this.attributes.linked_site_name
+
+  // int64 # Main Site ID
+  getMainSiteId = () => this.attributes.main_site_id
+
+  // string # Main Site Name
+  getMainSiteName = () => this.attributes.main_site_name
+
+  static linkeds = async (options = {}) => {
+    const response = await Api.sendRequest('/partner_sites/linked_partner_sites', 'GET', {}, options)
+
+    return response?.data?.map(obj => new PartnerSite(obj, 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).

package/src/models/PartnerSiteRequest.js

@@ -56,6 +56,13 @@ class PartnerSiteRequest {
     this.attributes.status = value
   }
 
+  // string # Main Site Name
+  getMainSiteName = () => this.attributes.main_site_name
+
+  setMainSiteName = value => {
+    this.attributes.main_site_name = value
+  }
+
   // string # Pairing key used to approve this request on the target site
   getPairingKey = () => this.attributes.pairing_key
 

package/src/models/User.js

@@ -949,7 +949,7 @@ class 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 `site_id`, `workspace_id`, `company`, `name`, `disabled`, `authenticate_until`, `username`, `email`, `last_desktop_login_at`, `last_login_at`, `site_admin`, `password_validity_days` or `ssl_required`.
-  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled`, `partner_id` or `workspace_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]`, `[ workspace_id, username ]`, `[ company, name ]`, `[ workspace_id, name ]`, `[ workspace_id, email ]`, `[ workspace_id, company ]`, `[ workspace_id, disabled ]`, `[ workspace_id, disabled, username ]` or `[ workspace_id, company, name ]`.
+  //   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled`, `partner_id` or `workspace_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]`, `[ workspace_id, username ]`, `[ company, name ]`, `[ workspace_id, name ]`, `[ workspace_id, email ]`, `[ workspace_id, company ]`, `[ workspace_id, disabled ]`, `[ workspace_id, partner_id ]`, `[ workspace_id, disabled, username ]`, `[ workspace_id, partner_id, username ]` or `[ workspace_id, company, name ]`.
   //   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
   //   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
   //   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.