files.com 1.1.11 → 1.1.13
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/models/ApiKey.md +1 -3
- package/docs/models/Group.md +30 -2
- package/docs/models/Site.md +2 -0
- package/lib/Files.js +1 -1
- package/lib/models/ApiKey.js +7 -7
- package/lib/models/Group.js +36 -0
- package/lib/models/Site.js +1 -0
- package/package.json +1 -1
- package/src/Files.js +1 -1
- package/src/models/ApiKey.js +7 -7
- package/src/models/Group.js +36 -0
- package/src/models/Site.js +1 -0
package/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.13
|
package/docs/models/ApiKey.md
CHANGED
@@ -12,7 +12,6 @@
|
|
12
12
|
"key": "[key]",
|
13
13
|
"last_use_at": "2000-01-01T01:00:00Z",
|
14
14
|
"name": "My Main API Key",
|
15
|
-
"path": "shared/docs",
|
16
15
|
"permission_set": "full",
|
17
16
|
"platform": "win32",
|
18
17
|
"url": "example",
|
@@ -28,11 +27,11 @@
|
|
28
27
|
* `key` (string): API Key actual key string
|
29
28
|
* `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
|
30
29
|
* `name` (string): Internal name for the API Key. For your use.
|
31
|
-
* `path` (string): Folder path restriction for this api key. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
32
30
|
* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
33
31
|
* `platform` (string): If this API key represents a Desktop app, what platform was it created on?
|
34
32
|
* `url` (string): URL for API host.
|
35
33
|
* `user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
|
34
|
+
* `path` (string): Folder path restriction for this api key.
|
36
35
|
|
37
36
|
---
|
38
37
|
|
@@ -168,7 +167,6 @@ await api_key.update({
|
|
168
167
|
"key": "[key]",
|
169
168
|
"last_use_at": "2000-01-01T01:00:00Z",
|
170
169
|
"name": "My Main API Key",
|
171
|
-
"path": "shared/docs",
|
172
170
|
"permission_set": "full",
|
173
171
|
"platform": "win32",
|
174
172
|
"url": "example",
|
package/docs/models/Group.md
CHANGED
@@ -9,7 +9,11 @@
|
|
9
9
|
"admin_ids": "1",
|
10
10
|
"notes": "example",
|
11
11
|
"user_ids": "1",
|
12
|
-
"usernames": "example"
|
12
|
+
"usernames": "example",
|
13
|
+
"ftp_permission": true,
|
14
|
+
"sftp_permission": true,
|
15
|
+
"dav_permission": true,
|
16
|
+
"restapi_permission": true
|
13
17
|
}
|
14
18
|
```
|
15
19
|
|
@@ -19,6 +23,10 @@
|
|
19
23
|
* `notes` (string): Notes about this group
|
20
24
|
* `user_ids` (string): Comma-delimited list of user IDs who belong to this group (separated by commas)
|
21
25
|
* `usernames` (string): Comma-delimited list of usernames who belong to this group (separated by commas)
|
26
|
+
* `ftp_permission` (boolean): If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
27
|
+
* `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.
|
28
|
+
* `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.
|
29
|
+
* `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.
|
22
30
|
|
23
31
|
---
|
24
32
|
|
@@ -62,6 +70,10 @@ await Group.create({
|
|
62
70
|
'notes': "example",
|
63
71
|
'user_ids': "1",
|
64
72
|
'admin_ids': "1",
|
73
|
+
'ftp_permission': true,
|
74
|
+
'sftp_permission': true,
|
75
|
+
'dav_permission': true,
|
76
|
+
'restapi_permission': true,
|
65
77
|
'name': "name",
|
66
78
|
})
|
67
79
|
```
|
@@ -72,6 +84,10 @@ await Group.create({
|
|
72
84
|
* `notes` (string): Group notes.
|
73
85
|
* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
|
74
86
|
* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
|
87
|
+
* `ftp_permission` (boolean): If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
88
|
+
* `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.
|
89
|
+
* `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.
|
90
|
+
* `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.
|
75
91
|
* `name` (string): Required - Group name.
|
76
92
|
|
77
93
|
---
|
@@ -85,6 +101,10 @@ await group.update({
|
|
85
101
|
'notes': "example",
|
86
102
|
'user_ids': "1",
|
87
103
|
'admin_ids': "1",
|
104
|
+
'ftp_permission': true,
|
105
|
+
'sftp_permission': true,
|
106
|
+
'dav_permission': true,
|
107
|
+
'restapi_permission': true,
|
88
108
|
'name': "owners",
|
89
109
|
})
|
90
110
|
```
|
@@ -95,6 +115,10 @@ await group.update({
|
|
95
115
|
* `notes` (string): Group notes.
|
96
116
|
* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
|
97
117
|
* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
|
118
|
+
* `ftp_permission` (boolean): If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
119
|
+
* `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.
|
120
|
+
* `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.
|
121
|
+
* `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.
|
98
122
|
* `name` (string): Group name.
|
99
123
|
|
100
124
|
### Example Response
|
@@ -106,7 +130,11 @@ await group.update({
|
|
106
130
|
"admin_ids": "1",
|
107
131
|
"notes": "example",
|
108
132
|
"user_ids": "1",
|
109
|
-
"usernames": "example"
|
133
|
+
"usernames": "example",
|
134
|
+
"ftp_permission": true,
|
135
|
+
"sftp_permission": true,
|
136
|
+
"dav_permission": true,
|
137
|
+
"restapi_permission": true
|
110
138
|
}
|
111
139
|
```
|
112
140
|
|
package/docs/models/Site.md
CHANGED
@@ -485,6 +485,7 @@ await Site.update({
|
|
485
485
|
'sftp_enabled': true,
|
486
486
|
'sftp_host_key_type': "default",
|
487
487
|
'active_sftp_host_key_id': 1,
|
488
|
+
'protocol_access_groups_only': true,
|
488
489
|
'bundle_watermark_value': {"key":"example value"},
|
489
490
|
'group_admins_can_set_user_password': true,
|
490
491
|
'bundle_recipient_blacklist_free_email_domains': true,
|
@@ -624,6 +625,7 @@ await Site.update({
|
|
624
625
|
* `sftp_enabled` (boolean): Is SFTP enabled?
|
625
626
|
* `sftp_host_key_type` (string): Sftp Host Key Type
|
626
627
|
* `active_sftp_host_key_id` (int64): Id of the currently selected custom SFTP Host Key
|
628
|
+
* `protocol_access_groups_only` (boolean): If `true`, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
|
627
629
|
* `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
628
630
|
* `group_admins_can_set_user_password` (boolean): Allow group admins set password authentication method
|
629
631
|
* `bundle_recipient_blacklist_free_email_domains` (boolean): Disallow free email domains for Bundle/Inbox recipients?
|
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.1.
|
14
|
+
var version = '1.1.13';
|
15
15
|
var userAgent = "Files.com JavaScript SDK v".concat(version);
|
16
16
|
var logLevel = _Logger.LogLevel.INFO;
|
17
17
|
var debugRequest = false;
|
package/lib/models/ApiKey.js
CHANGED
@@ -86,13 +86,6 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
|
|
86
86
|
(0, _defineProperty2.default)(this, "setName", function (value) {
|
87
87
|
_this.attributes.name = value;
|
88
88
|
});
|
89
|
-
// string # Folder path restriction for this api key. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
90
|
-
(0, _defineProperty2.default)(this, "getPath", function () {
|
91
|
-
return _this.attributes.path;
|
92
|
-
});
|
93
|
-
(0, _defineProperty2.default)(this, "setPath", function (value) {
|
94
|
-
_this.attributes.path = value;
|
95
|
-
});
|
96
89
|
// string # Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
97
90
|
(0, _defineProperty2.default)(this, "getPermissionSet", function () {
|
98
91
|
return _this.attributes.permission_set;
|
@@ -121,6 +114,13 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
|
|
121
114
|
(0, _defineProperty2.default)(this, "setUserId", function (value) {
|
122
115
|
_this.attributes.user_id = value;
|
123
116
|
});
|
117
|
+
// string # Folder path restriction for this api key.
|
118
|
+
(0, _defineProperty2.default)(this, "getPath", function () {
|
119
|
+
return _this.attributes.path;
|
120
|
+
});
|
121
|
+
(0, _defineProperty2.default)(this, "setPath", function (value) {
|
122
|
+
_this.attributes.path = value;
|
123
|
+
});
|
124
124
|
// Parameters:
|
125
125
|
// name - string - Internal name for the API Key. For your use.
|
126
126
|
// description - string - User-supplied description of API key.
|
package/lib/models/Group.js
CHANGED
@@ -75,10 +75,42 @@ var Group = /*#__PURE__*/(0, _createClass2.default)(function Group() {
|
|
75
75
|
(0, _defineProperty2.default)(this, "setUsernames", function (value) {
|
76
76
|
_this.attributes.usernames = value;
|
77
77
|
});
|
78
|
+
// boolean # If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
79
|
+
(0, _defineProperty2.default)(this, "getFtpPermission", function () {
|
80
|
+
return _this.attributes.ftp_permission;
|
81
|
+
});
|
82
|
+
(0, _defineProperty2.default)(this, "setFtpPermission", function (value) {
|
83
|
+
_this.attributes.ftp_permission = value;
|
84
|
+
});
|
85
|
+
// 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.
|
86
|
+
(0, _defineProperty2.default)(this, "getSftpPermission", function () {
|
87
|
+
return _this.attributes.sftp_permission;
|
88
|
+
});
|
89
|
+
(0, _defineProperty2.default)(this, "setSftpPermission", function (value) {
|
90
|
+
_this.attributes.sftp_permission = value;
|
91
|
+
});
|
92
|
+
// 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.
|
93
|
+
(0, _defineProperty2.default)(this, "getDavPermission", function () {
|
94
|
+
return _this.attributes.dav_permission;
|
95
|
+
});
|
96
|
+
(0, _defineProperty2.default)(this, "setDavPermission", function (value) {
|
97
|
+
_this.attributes.dav_permission = value;
|
98
|
+
});
|
99
|
+
// 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.
|
100
|
+
(0, _defineProperty2.default)(this, "getRestapiPermission", function () {
|
101
|
+
return _this.attributes.restapi_permission;
|
102
|
+
});
|
103
|
+
(0, _defineProperty2.default)(this, "setRestapiPermission", function (value) {
|
104
|
+
_this.attributes.restapi_permission = value;
|
105
|
+
});
|
78
106
|
// Parameters:
|
79
107
|
// notes - string - Group notes.
|
80
108
|
// user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
81
109
|
// admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
110
|
+
// ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
111
|
+
// 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.
|
112
|
+
// 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.
|
113
|
+
// 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.
|
82
114
|
// name - string - Group name.
|
83
115
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
84
116
|
var params,
|
@@ -364,6 +396,10 @@ _class = Group;
|
|
364
396
|
// notes - string - Group notes.
|
365
397
|
// user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
366
398
|
// admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
399
|
+
// ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
400
|
+
// 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.
|
401
|
+
// 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.
|
402
|
+
// 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.
|
367
403
|
// name (required) - string - Group name.
|
368
404
|
(0, _defineProperty2.default)(Group, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
|
369
405
|
var params,
|
package/lib/models/Site.js
CHANGED
@@ -769,6 +769,7 @@ _class = Site;
|
|
769
769
|
// sftp_enabled - boolean - Is SFTP enabled?
|
770
770
|
// sftp_host_key_type - string - Sftp Host Key Type
|
771
771
|
// active_sftp_host_key_id - int64 - Id of the currently selected custom SFTP Host Key
|
772
|
+
// protocol_access_groups_only - boolean - If `true`, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
|
772
773
|
// bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
773
774
|
// group_admins_can_set_user_password - boolean - Allow group admins set password authentication method
|
774
775
|
// bundle_recipient_blacklist_free_email_domains - boolean - Disallow free email domains for Bundle/Inbox recipients?
|
package/package.json
CHANGED
package/src/Files.js
CHANGED
package/src/models/ApiKey.js
CHANGED
@@ -76,13 +76,6 @@ class ApiKey {
|
|
76
76
|
this.attributes.name = value
|
77
77
|
}
|
78
78
|
|
79
|
-
// string # Folder path restriction for this api key. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
80
|
-
getPath = () => this.attributes.path
|
81
|
-
|
82
|
-
setPath = value => {
|
83
|
-
this.attributes.path = value
|
84
|
-
}
|
85
|
-
|
86
79
|
// string # Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
87
80
|
getPermissionSet = () => this.attributes.permission_set
|
88
81
|
|
@@ -111,6 +104,13 @@ class ApiKey {
|
|
111
104
|
this.attributes.user_id = value
|
112
105
|
}
|
113
106
|
|
107
|
+
// string # Folder path restriction for this api key.
|
108
|
+
getPath = () => this.attributes.path
|
109
|
+
|
110
|
+
setPath = value => {
|
111
|
+
this.attributes.path = value
|
112
|
+
}
|
113
|
+
|
114
114
|
|
115
115
|
// Parameters:
|
116
116
|
// name - string - Internal name for the API Key. For your use.
|
package/src/models/Group.js
CHANGED
@@ -66,11 +66,43 @@ class Group {
|
|
66
66
|
this.attributes.usernames = value
|
67
67
|
}
|
68
68
|
|
69
|
+
// boolean # If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
70
|
+
getFtpPermission = () => this.attributes.ftp_permission
|
71
|
+
|
72
|
+
setFtpPermission = value => {
|
73
|
+
this.attributes.ftp_permission = value
|
74
|
+
}
|
75
|
+
|
76
|
+
// 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.
|
77
|
+
getSftpPermission = () => this.attributes.sftp_permission
|
78
|
+
|
79
|
+
setSftpPermission = value => {
|
80
|
+
this.attributes.sftp_permission = value
|
81
|
+
}
|
82
|
+
|
83
|
+
// 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.
|
84
|
+
getDavPermission = () => this.attributes.dav_permission
|
85
|
+
|
86
|
+
setDavPermission = value => {
|
87
|
+
this.attributes.dav_permission = value
|
88
|
+
}
|
89
|
+
|
90
|
+
// 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.
|
91
|
+
getRestapiPermission = () => this.attributes.restapi_permission
|
92
|
+
|
93
|
+
setRestapiPermission = value => {
|
94
|
+
this.attributes.restapi_permission = value
|
95
|
+
}
|
96
|
+
|
69
97
|
|
70
98
|
// Parameters:
|
71
99
|
// notes - string - Group notes.
|
72
100
|
// user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
73
101
|
// admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
102
|
+
// ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
103
|
+
// 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.
|
104
|
+
// 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.
|
105
|
+
// 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.
|
74
106
|
// name - string - Group name.
|
75
107
|
update = async (params = {}) => {
|
76
108
|
if (!this.attributes.id) {
|
@@ -213,6 +245,10 @@ class Group {
|
|
213
245
|
// notes - string - Group notes.
|
214
246
|
// user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
215
247
|
// admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
248
|
+
// ftp_permission - boolean - If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
249
|
+
// 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.
|
250
|
+
// 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.
|
251
|
+
// 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.
|
216
252
|
// name (required) - string - Group name.
|
217
253
|
static create = async (params = {}, options = {}) => {
|
218
254
|
if (!params['name']) {
|
package/src/models/Site.js
CHANGED
@@ -571,6 +571,7 @@ class Site {
|
|
571
571
|
// sftp_enabled - boolean - Is SFTP enabled?
|
572
572
|
// sftp_host_key_type - string - Sftp Host Key Type
|
573
573
|
// active_sftp_host_key_id - int64 - Id of the currently selected custom SFTP Host Key
|
574
|
+
// protocol_access_groups_only - boolean - If `true`, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
|
574
575
|
// bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
575
576
|
// group_admins_can_set_user_password - boolean - Allow group admins set password authentication method
|
576
577
|
// bundle_recipient_blacklist_free_email_domains - boolean - Disallow free email domains for Bundle/Inbox recipients?
|