files.com 1.2.169 → 1.2.170

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.169
1
+ 1.2.170
@@ -14,7 +14,8 @@
14
14
  "ftp_permission": true,
15
15
  "sftp_permission": true,
16
16
  "dav_permission": true,
17
- "restapi_permission": true
17
+ "restapi_permission": true,
18
+ "site_id": 1
18
19
  }
19
20
  ```
20
21
 
@@ -29,13 +30,16 @@
29
30
  * `sftp_permission` (boolean): If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
30
31
  * `dav_permission` (boolean): If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
31
32
  * `restapi_permission` (boolean): If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
33
+ * `site_id` (int64): Site ID
32
34
 
33
35
  ---
34
36
 
35
37
  ## List Groups
36
38
 
37
39
  ```
38
- await Group.list
40
+ await Group.list({
41
+ 'include_parent_site_groups': true,
42
+ })
39
43
  ```
40
44
 
41
45
 
@@ -43,10 +47,11 @@ await Group.list
43
47
 
44
48
  * `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.
45
49
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
46
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
50
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `name`.
47
51
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
48
52
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
49
53
  * `ids` (string): Comma-separated list of group ids to include in results.
54
+ * `include_parent_site_groups` (boolean): Include groups from the parent site.
50
55
 
51
56
  ---
52
57
 
@@ -139,7 +144,8 @@ await group.update({
139
144
  "ftp_permission": true,
140
145
  "sftp_permission": true,
141
146
  "dav_permission": true,
142
- "restapi_permission": true
147
+ "restapi_permission": true,
148
+ "site_id": 1
143
149
  }
144
150
  ```
145
151
 
@@ -266,6 +266,7 @@
266
266
  "self_managed": true,
267
267
  "sftp_permission": true,
268
268
  "site_admin": true,
269
+ "site_id": 1,
269
270
  "skip_welcome_screen": true,
270
271
  "ssl_required": "always_require",
271
272
  "sso_strategy_id": 1,
@@ -59,6 +59,7 @@
59
59
  "self_managed": true,
60
60
  "sftp_permission": true,
61
61
  "site_admin": true,
62
+ "site_id": 1,
62
63
  "skip_welcome_screen": true,
63
64
  "ssl_required": "always_require",
64
65
  "sso_strategy_id": 1,
@@ -127,6 +128,7 @@
127
128
  * `self_managed` (boolean): Does this user manage it's own credentials or is it a shared/bot user?
128
129
  * `sftp_permission` (boolean): Can the user access with SFTP?
129
130
  * `site_admin` (boolean): Is the user an administrator for this site?
131
+ * `site_id` (int64): Site ID
130
132
  * `skip_welcome_screen` (boolean): Skip Welcome page in the UI?
131
133
  * `ssl_required` (string): SSL required setting
132
134
  * `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
@@ -155,7 +157,9 @@
155
157
  ## List Users
156
158
 
157
159
  ```
158
- await User.list
160
+ await User.list({
161
+ 'include_parent_site_users': true,
162
+ })
159
163
  ```
160
164
 
161
165
 
@@ -163,7 +167,7 @@ await User.list
163
167
 
164
168
  * `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.
165
169
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
166
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
170
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
167
171
  * `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` or `not_site_admin`. Valid field combinations are `[ username, not_site_admin ]` and `[ name, company ]`.
168
172
  * `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`.
169
173
  * `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`.
@@ -171,6 +175,7 @@ await User.list
171
175
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
172
176
  * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
173
177
  * `ids` (string): comma-separated list of User IDs
178
+ * `include_parent_site_users` (boolean): Include users from the parent site.
174
179
  * `search` (string): Searches for partial matches of name, username, or email.
175
180
 
176
181
  ---
@@ -492,6 +497,7 @@ await user.update({
492
497
  "self_managed": true,
493
498
  "sftp_permission": true,
494
499
  "site_admin": true,
500
+ "site_id": 1,
495
501
  "skip_welcome_screen": true,
496
502
  "ssl_required": "always_require",
497
503
  "sso_strategy_id": 1,
package/lib/Files.js CHANGED
@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
11
11
  var apiKey;
12
12
  var baseUrl = 'https://app.files.com';
13
13
  var sessionId = null;
14
- var version = '1.2.169';
14
+ var version = '1.2.170';
15
15
  var userAgent = "Files.com JavaScript SDK v".concat(version);
16
16
  var logLevel = _Logger.LogLevel.INFO;
17
17
  var debugRequest = false;
@@ -110,6 +110,13 @@ var Group = /*#__PURE__*/(0, _createClass2.default)(function Group() {
110
110
  (0, _defineProperty2.default)(this, "setRestapiPermission", function (value) {
111
111
  _this.attributes.restapi_permission = value;
112
112
  });
113
+ // int64 # Site ID
114
+ (0, _defineProperty2.default)(this, "getSiteId", function () {
115
+ return _this.attributes.site_id;
116
+ });
117
+ (0, _defineProperty2.default)(this, "setSiteId", function (value) {
118
+ _this.attributes.site_id = value;
119
+ });
113
120
  // Parameters:
114
121
  // notes - string - Group notes.
115
122
  // user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
@@ -299,10 +306,11 @@ _Group = Group;
299
306
  // Parameters:
300
307
  // 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.
301
308
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
302
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
309
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `name`.
303
310
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
304
311
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
305
312
  // ids - string - Comma-separated list of group ids to include in results.
313
+ // include_parent_site_groups - boolean - Include groups from the parent site.
306
314
  (0, _defineProperty2.default)(Group, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
307
315
  var _response$data;
308
316
  var params,
@@ -401,6 +401,13 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
401
401
  (0, _defineProperty2.default)(this, "setSiteAdmin", function (value) {
402
402
  _this.attributes.site_admin = value;
403
403
  });
404
+ // int64 # Site ID
405
+ (0, _defineProperty2.default)(this, "getSiteId", function () {
406
+ return _this.attributes.site_id;
407
+ });
408
+ (0, _defineProperty2.default)(this, "setSiteId", function (value) {
409
+ _this.attributes.site_id = value;
410
+ });
404
411
  // boolean # Skip Welcome page in the UI?
405
412
  (0, _defineProperty2.default)(this, "getSkipWelcomeScreen", function () {
406
413
  return _this.attributes.skip_welcome_screen;
@@ -1061,7 +1068,7 @@ _User = User;
1061
1068
  // Parameters:
1062
1069
  // 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.
1063
1070
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
1064
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
1071
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
1065
1072
  // 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` or `not_site_admin`. Valid field combinations are `[ username, not_site_admin ]` and `[ name, company ]`.
1066
1073
  // 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`.
1067
1074
  // 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`.
@@ -1069,6 +1076,7 @@ _User = User;
1069
1076
  // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
1070
1077
  // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
1071
1078
  // ids - string - comma-separated list of User IDs
1079
+ // include_parent_site_users - boolean - Include users from the parent site.
1072
1080
  // search - string - Searches for partial matches of name, username, or email.
1073
1081
  (0, _defineProperty2.default)(User, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee7() {
1074
1082
  var _response$data;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "files.com",
3
- "version": "1.2.169",
3
+ "version": "1.2.170",
4
4
  "description": "Files.com SDK for JavaScript",
5
5
  "keywords": [
6
6
  "files.com",
package/src/Files.js CHANGED
@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
5
5
  let apiKey
6
6
  let baseUrl = 'https://app.files.com'
7
7
  let sessionId = null
8
- const version = '1.2.169'
8
+ const version = '1.2.170'
9
9
  let userAgent = `Files.com JavaScript SDK v${version}`
10
10
 
11
11
  let logLevel = LogLevel.INFO
@@ -105,6 +105,13 @@ class Group {
105
105
  this.attributes.restapi_permission = value
106
106
  }
107
107
 
108
+ // int64 # Site ID
109
+ getSiteId = () => this.attributes.site_id
110
+
111
+ setSiteId = value => {
112
+ this.attributes.site_id = value
113
+ }
114
+
108
115
  // Parameters:
109
116
  // notes - string - Group notes.
110
117
  // user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
@@ -205,10 +212,11 @@ class Group {
205
212
  // Parameters:
206
213
  // 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.
207
214
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
208
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
215
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `name`.
209
216
  // filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
210
217
  // filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
211
218
  // ids - string - Comma-separated list of group ids to include in results.
219
+ // include_parent_site_groups - boolean - Include groups from the parent site.
212
220
  static list = async (params = {}, options = {}) => {
213
221
  if (params.cursor && !isString(params.cursor)) {
214
222
  throw new errors.InvalidParameterError(`Bad parameter: cursor must be of type String, received ${getType(params.cursor)}`)
@@ -395,6 +395,13 @@ class User {
395
395
  this.attributes.site_admin = value
396
396
  }
397
397
 
398
+ // int64 # Site ID
399
+ getSiteId = () => this.attributes.site_id
400
+
401
+ setSiteId = value => {
402
+ this.attributes.site_id = value
403
+ }
404
+
398
405
  // boolean # Skip Welcome page in the UI?
399
406
  getSkipWelcomeScreen = () => this.attributes.skip_welcome_screen
400
407
 
@@ -853,7 +860,7 @@ class User {
853
860
  // Parameters:
854
861
  // 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.
855
862
  // per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
856
- // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
863
+ // sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `name`, `company`, `site_admin`, `password_validity_days` or `ssl_required`.
857
864
  // 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` or `not_site_admin`. Valid field combinations are `[ username, not_site_admin ]` and `[ name, company ]`.
858
865
  // 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`.
859
866
  // 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`.
@@ -861,6 +868,7 @@ class User {
861
868
  // filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
862
869
  // filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
863
870
  // ids - string - comma-separated list of User IDs
871
+ // include_parent_site_users - boolean - Include users from the parent site.
864
872
  // search - string - Searches for partial matches of name, username, or email.
865
873
  static list = async (params = {}, options = {}) => {
866
874
  if (params.cursor && !isString(params.cursor)) {