files.com 1.0.247 → 1.0.249
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 +1 -1
- package/docs/models/RemoteServer.md +16 -2
- package/lib/models/AccountLineItem.js +14 -0
- package/lib/models/Action.js +13 -0
- package/lib/models/ActionNotificationExport.js +27 -0
- package/lib/models/ActionNotificationExportResult.js +15 -0
- package/lib/models/ActionWebhookFailure.js +1 -0
- package/lib/models/ApiKey.js +42 -0
- package/lib/models/App.js +26 -0
- package/lib/models/As2IncomingMessage.js +46 -0
- package/lib/models/As2OutgoingMessage.js +42 -0
- package/lib/models/As2Partner.js +29 -0
- package/lib/models/As2Station.js +31 -0
- package/lib/models/Auto.js +1 -0
- package/lib/models/Automation.js +72 -0
- package/lib/models/AutomationRun.js +20 -0
- package/lib/models/BandwidthSnapshot.js +19 -0
- package/lib/models/Behavior.js +57 -0
- package/lib/models/Bundle.js +98 -0
- package/lib/models/BundleDownload.js +16 -0
- package/lib/models/BundleNotification.js +20 -0
- package/lib/models/BundleRecipient.js +28 -0
- package/lib/models/BundleRegistration.js +18 -0
- package/lib/models/Clickwrap.js +23 -0
- package/lib/models/DnsRecord.js +7 -0
- package/lib/models/Errors.js +2 -0
- package/lib/models/ExternalEvent.js +26 -0
- package/lib/models/File.js +88 -0
- package/lib/models/FileAction.js +2 -0
- package/lib/models/FileComment.js +13 -0
- package/lib/models/FileCommentReaction.js +8 -0
- package/lib/models/FileMigration.js +11 -0
- package/lib/models/FileUploadPart.js +15 -0
- package/lib/models/Folder.js +33 -0
- package/lib/models/FormField.js +8 -0
- package/lib/models/FormFieldSet.js +27 -0
- package/lib/models/Group.js +29 -0
- package/lib/models/GroupUser.js +22 -0
- package/lib/models/History.js +57 -0
- package/lib/models/HistoryExport.js +51 -0
- package/lib/models/HistoryExportResult.js +29 -0
- package/lib/models/Image.js +2 -0
- package/lib/models/InboxRecipient.js +28 -0
- package/lib/models/InboxRegistration.js +15 -0
- package/lib/models/InboxUpload.js +15 -0
- package/lib/models/Invoice.js +19 -0
- package/lib/models/InvoiceLineItem.js +9 -0
- package/lib/models/IpAddress.js +13 -0
- package/lib/models/Lock.js +25 -0
- package/lib/models/Message.js +22 -0
- package/lib/models/MessageComment.js +16 -0
- package/lib/models/MessageCommentReaction.js +13 -0
- package/lib/models/MessageReaction.js +13 -0
- package/lib/models/Notification.js +70 -0
- package/lib/models/Payment.js +19 -0
- package/lib/models/PaymentLineItem.js +4 -0
- package/lib/models/Permission.js +29 -0
- package/lib/models/Preview.js +5 -0
- package/lib/models/Priority.js +6 -0
- package/lib/models/Project.js +11 -0
- package/lib/models/PublicIpAddress.js +4 -0
- package/lib/models/PublicKey.js +18 -0
- package/lib/models/RemoteBandwidthSnapshot.js +15 -0
- package/lib/models/RemoteServer.js +253 -11
- package/lib/models/RemoteServerConfigurationFile.js +12 -0
- package/lib/models/Request.js +25 -0
- package/lib/models/Session.js +13 -0
- package/lib/models/SettingsChange.js +15 -0
- package/lib/models/SftpHostKey.js +16 -0
- package/lib/models/Site.js +276 -0
- package/lib/models/SsoStrategy.js +49 -0
- package/lib/models/Status.js +7 -0
- package/lib/models/Style.js +9 -0
- package/lib/models/UsageDailySnapshot.js +21 -0
- package/lib/models/UsageSnapshot.js +18 -0
- package/lib/models/User.js +183 -0
- package/lib/models/UserCipherUse.js +10 -0
- package/lib/models/UserRequest.js +13 -0
- package/lib/models/WebhookTest.js +24 -0
- package/package.json +1 -1
- package/src/models/RemoteServer.js +41 -0
package/lib/models/User.js
CHANGED
@@ -31,417 +31,487 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// int64 # User ID
|
34
35
|
(0, _defineProperty2.default)(this, "getId", function () {
|
35
36
|
return _this.attributes.id;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
38
39
|
_this.attributes.id = value;
|
39
40
|
});
|
41
|
+
// string # User's username
|
40
42
|
(0, _defineProperty2.default)(this, "getUsername", function () {
|
41
43
|
return _this.attributes.username;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setUsername", function (value) {
|
44
46
|
_this.attributes.username = value;
|
45
47
|
});
|
48
|
+
// array # List of group IDs of which this user is an administrator
|
46
49
|
(0, _defineProperty2.default)(this, "getAdminGroupIds", function () {
|
47
50
|
return _this.attributes.admin_group_ids;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setAdminGroupIds", function (value) {
|
50
53
|
_this.attributes.admin_group_ids = value;
|
51
54
|
});
|
55
|
+
// string # A list of allowed IPs if applicable. Newline delimited
|
52
56
|
(0, _defineProperty2.default)(this, "getAllowedIps", function () {
|
53
57
|
return _this.attributes.allowed_ips;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setAllowedIps", function (value) {
|
56
60
|
_this.attributes.allowed_ips = value;
|
57
61
|
});
|
62
|
+
// boolean # DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
|
58
63
|
(0, _defineProperty2.default)(this, "getAttachmentsPermission", function () {
|
59
64
|
return _this.attributes.attachments_permission;
|
60
65
|
});
|
61
66
|
(0, _defineProperty2.default)(this, "setAttachmentsPermission", function (value) {
|
62
67
|
_this.attributes.attachments_permission = value;
|
63
68
|
});
|
69
|
+
// int64 # Number of api keys associated with this user
|
64
70
|
(0, _defineProperty2.default)(this, "getApiKeysCount", function () {
|
65
71
|
return _this.attributes.api_keys_count;
|
66
72
|
});
|
67
73
|
(0, _defineProperty2.default)(this, "setApiKeysCount", function (value) {
|
68
74
|
_this.attributes.api_keys_count = value;
|
69
75
|
});
|
76
|
+
// date-time # Scheduled Date/Time at which user will be deactivated
|
70
77
|
(0, _defineProperty2.default)(this, "getAuthenticateUntil", function () {
|
71
78
|
return _this.attributes.authenticate_until;
|
72
79
|
});
|
73
80
|
(0, _defineProperty2.default)(this, "setAuthenticateUntil", function (value) {
|
74
81
|
_this.attributes.authenticate_until = value;
|
75
82
|
});
|
83
|
+
// string # How is this user authenticated?
|
76
84
|
(0, _defineProperty2.default)(this, "getAuthenticationMethod", function () {
|
77
85
|
return _this.attributes.authentication_method;
|
78
86
|
});
|
79
87
|
(0, _defineProperty2.default)(this, "setAuthenticationMethod", function (value) {
|
80
88
|
_this.attributes.authentication_method = value;
|
81
89
|
});
|
90
|
+
// string # URL holding the user's avatar
|
82
91
|
(0, _defineProperty2.default)(this, "getAvatarUrl", function () {
|
83
92
|
return _this.attributes.avatar_url;
|
84
93
|
});
|
85
94
|
(0, _defineProperty2.default)(this, "setAvatarUrl", function (value) {
|
86
95
|
_this.attributes.avatar_url = value;
|
87
96
|
});
|
97
|
+
// boolean # Allow this user to perform operations on the account, payments, and invoices?
|
88
98
|
(0, _defineProperty2.default)(this, "getBillingPermission", function () {
|
89
99
|
return _this.attributes.billing_permission;
|
90
100
|
});
|
91
101
|
(0, _defineProperty2.default)(this, "setBillingPermission", function (value) {
|
92
102
|
_this.attributes.billing_permission = value;
|
93
103
|
});
|
104
|
+
// boolean # Allow this user to skip site-wide IP blacklists?
|
94
105
|
(0, _defineProperty2.default)(this, "getBypassSiteAllowedIps", function () {
|
95
106
|
return _this.attributes.bypass_site_allowed_ips;
|
96
107
|
});
|
97
108
|
(0, _defineProperty2.default)(this, "setBypassSiteAllowedIps", function (value) {
|
98
109
|
_this.attributes.bypass_site_allowed_ips = value;
|
99
110
|
});
|
111
|
+
// boolean # Exempt this user from being disabled based on inactivity?
|
100
112
|
(0, _defineProperty2.default)(this, "getBypassInactiveDisable", function () {
|
101
113
|
return _this.attributes.bypass_inactive_disable;
|
102
114
|
});
|
103
115
|
(0, _defineProperty2.default)(this, "setBypassInactiveDisable", function (value) {
|
104
116
|
_this.attributes.bypass_inactive_disable = value;
|
105
117
|
});
|
118
|
+
// date-time # When this user was created
|
106
119
|
(0, _defineProperty2.default)(this, "getCreatedAt", function () {
|
107
120
|
return _this.attributes.created_at;
|
108
121
|
});
|
122
|
+
// boolean # Can the user connect with WebDAV?
|
109
123
|
(0, _defineProperty2.default)(this, "getDavPermission", function () {
|
110
124
|
return _this.attributes.dav_permission;
|
111
125
|
});
|
112
126
|
(0, _defineProperty2.default)(this, "setDavPermission", function (value) {
|
113
127
|
_this.attributes.dav_permission = value;
|
114
128
|
});
|
129
|
+
// boolean # Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting.
|
115
130
|
(0, _defineProperty2.default)(this, "getDisabled", function () {
|
116
131
|
return _this.attributes.disabled;
|
117
132
|
});
|
118
133
|
(0, _defineProperty2.default)(this, "setDisabled", function (value) {
|
119
134
|
_this.attributes.disabled = value;
|
120
135
|
});
|
136
|
+
// email # User email address
|
121
137
|
(0, _defineProperty2.default)(this, "getEmail", function () {
|
122
138
|
return _this.attributes.email;
|
123
139
|
});
|
124
140
|
(0, _defineProperty2.default)(this, "setEmail", function (value) {
|
125
141
|
_this.attributes.email = value;
|
126
142
|
});
|
143
|
+
// date-time # User's first login time
|
127
144
|
(0, _defineProperty2.default)(this, "getFirstLoginAt", function () {
|
128
145
|
return _this.attributes.first_login_at;
|
129
146
|
});
|
130
147
|
(0, _defineProperty2.default)(this, "setFirstLoginAt", function (value) {
|
131
148
|
_this.attributes.first_login_at = value;
|
132
149
|
});
|
150
|
+
// boolean # Can the user access with FTP/FTPS?
|
133
151
|
(0, _defineProperty2.default)(this, "getFtpPermission", function () {
|
134
152
|
return _this.attributes.ftp_permission;
|
135
153
|
});
|
136
154
|
(0, _defineProperty2.default)(this, "setFtpPermission", function (value) {
|
137
155
|
_this.attributes.ftp_permission = value;
|
138
156
|
});
|
157
|
+
// string # Comma-separated list of group IDs of which this user is a member
|
139
158
|
(0, _defineProperty2.default)(this, "getGroupIds", function () {
|
140
159
|
return _this.attributes.group_ids;
|
141
160
|
});
|
142
161
|
(0, _defineProperty2.default)(this, "setGroupIds", function (value) {
|
143
162
|
_this.attributes.group_ids = value;
|
144
163
|
});
|
164
|
+
// string # Text to display to the user in the header of the UI
|
145
165
|
(0, _defineProperty2.default)(this, "getHeaderText", function () {
|
146
166
|
return _this.attributes.header_text;
|
147
167
|
});
|
148
168
|
(0, _defineProperty2.default)(this, "setHeaderText", function (value) {
|
149
169
|
_this.attributes.header_text = value;
|
150
170
|
});
|
171
|
+
// string # Preferred language
|
151
172
|
(0, _defineProperty2.default)(this, "getLanguage", function () {
|
152
173
|
return _this.attributes.language;
|
153
174
|
});
|
154
175
|
(0, _defineProperty2.default)(this, "setLanguage", function (value) {
|
155
176
|
_this.attributes.language = value;
|
156
177
|
});
|
178
|
+
// date-time # User's most recent login time via any protocol
|
157
179
|
(0, _defineProperty2.default)(this, "getLastLoginAt", function () {
|
158
180
|
return _this.attributes.last_login_at;
|
159
181
|
});
|
160
182
|
(0, _defineProperty2.default)(this, "setLastLoginAt", function (value) {
|
161
183
|
_this.attributes.last_login_at = value;
|
162
184
|
});
|
185
|
+
// date-time # User's most recent login time via web
|
163
186
|
(0, _defineProperty2.default)(this, "getLastWebLoginAt", function () {
|
164
187
|
return _this.attributes.last_web_login_at;
|
165
188
|
});
|
166
189
|
(0, _defineProperty2.default)(this, "setLastWebLoginAt", function (value) {
|
167
190
|
_this.attributes.last_web_login_at = value;
|
168
191
|
});
|
192
|
+
// date-time # User's most recent login time via FTP
|
169
193
|
(0, _defineProperty2.default)(this, "getLastFtpLoginAt", function () {
|
170
194
|
return _this.attributes.last_ftp_login_at;
|
171
195
|
});
|
172
196
|
(0, _defineProperty2.default)(this, "setLastFtpLoginAt", function (value) {
|
173
197
|
_this.attributes.last_ftp_login_at = value;
|
174
198
|
});
|
199
|
+
// date-time # User's most recent login time via SFTP
|
175
200
|
(0, _defineProperty2.default)(this, "getLastSftpLoginAt", function () {
|
176
201
|
return _this.attributes.last_sftp_login_at;
|
177
202
|
});
|
178
203
|
(0, _defineProperty2.default)(this, "setLastSftpLoginAt", function (value) {
|
179
204
|
_this.attributes.last_sftp_login_at = value;
|
180
205
|
});
|
206
|
+
// date-time # User's most recent login time via WebDAV
|
181
207
|
(0, _defineProperty2.default)(this, "getLastDavLoginAt", function () {
|
182
208
|
return _this.attributes.last_dav_login_at;
|
183
209
|
});
|
184
210
|
(0, _defineProperty2.default)(this, "setLastDavLoginAt", function (value) {
|
185
211
|
_this.attributes.last_dav_login_at = value;
|
186
212
|
});
|
213
|
+
// date-time # User's most recent login time via Desktop app
|
187
214
|
(0, _defineProperty2.default)(this, "getLastDesktopLoginAt", function () {
|
188
215
|
return _this.attributes.last_desktop_login_at;
|
189
216
|
});
|
190
217
|
(0, _defineProperty2.default)(this, "setLastDesktopLoginAt", function (value) {
|
191
218
|
_this.attributes.last_desktop_login_at = value;
|
192
219
|
});
|
220
|
+
// date-time # User's most recent login time via Rest API
|
193
221
|
(0, _defineProperty2.default)(this, "getLastRestapiLoginAt", function () {
|
194
222
|
return _this.attributes.last_restapi_login_at;
|
195
223
|
});
|
196
224
|
(0, _defineProperty2.default)(this, "setLastRestapiLoginAt", function (value) {
|
197
225
|
_this.attributes.last_restapi_login_at = value;
|
198
226
|
});
|
227
|
+
// date-time # User's most recent API use time
|
199
228
|
(0, _defineProperty2.default)(this, "getLastApiUseAt", function () {
|
200
229
|
return _this.attributes.last_api_use_at;
|
201
230
|
});
|
202
231
|
(0, _defineProperty2.default)(this, "setLastApiUseAt", function (value) {
|
203
232
|
_this.attributes.last_api_use_at = value;
|
204
233
|
});
|
234
|
+
// date-time # User's most recent activity time, which is the latest of most recent login, most recent API use, enablement, or creation
|
205
235
|
(0, _defineProperty2.default)(this, "getLastActiveAt", function () {
|
206
236
|
return _this.attributes.last_active_at;
|
207
237
|
});
|
208
238
|
(0, _defineProperty2.default)(this, "setLastActiveAt", function (value) {
|
209
239
|
_this.attributes.last_active_at = value;
|
210
240
|
});
|
241
|
+
// string # The most recent protocol and cipher used
|
211
242
|
(0, _defineProperty2.default)(this, "getLastProtocolCipher", function () {
|
212
243
|
return _this.attributes.last_protocol_cipher;
|
213
244
|
});
|
214
245
|
(0, _defineProperty2.default)(this, "setLastProtocolCipher", function (value) {
|
215
246
|
_this.attributes.last_protocol_cipher = value;
|
216
247
|
});
|
248
|
+
// date-time # Time in the future that the user will no longer be locked out if applicable
|
217
249
|
(0, _defineProperty2.default)(this, "getLockoutExpires", function () {
|
218
250
|
return _this.attributes.lockout_expires;
|
219
251
|
});
|
220
252
|
(0, _defineProperty2.default)(this, "setLockoutExpires", function (value) {
|
221
253
|
_this.attributes.lockout_expires = value;
|
222
254
|
});
|
255
|
+
// string # User's full name
|
223
256
|
(0, _defineProperty2.default)(this, "getName", function () {
|
224
257
|
return _this.attributes.name;
|
225
258
|
});
|
226
259
|
(0, _defineProperty2.default)(this, "setName", function (value) {
|
227
260
|
_this.attributes.name = value;
|
228
261
|
});
|
262
|
+
// string # User's company
|
229
263
|
(0, _defineProperty2.default)(this, "getCompany", function () {
|
230
264
|
return _this.attributes.company;
|
231
265
|
});
|
232
266
|
(0, _defineProperty2.default)(this, "setCompany", function (value) {
|
233
267
|
_this.attributes.company = value;
|
234
268
|
});
|
269
|
+
// string # Any internal notes on the user
|
235
270
|
(0, _defineProperty2.default)(this, "getNotes", function () {
|
236
271
|
return _this.attributes.notes;
|
237
272
|
});
|
238
273
|
(0, _defineProperty2.default)(this, "setNotes", function (value) {
|
239
274
|
_this.attributes.notes = value;
|
240
275
|
});
|
276
|
+
// int64 # Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
|
241
277
|
(0, _defineProperty2.default)(this, "getNotificationDailySendTime", function () {
|
242
278
|
return _this.attributes.notification_daily_send_time;
|
243
279
|
});
|
244
280
|
(0, _defineProperty2.default)(this, "setNotificationDailySendTime", function (value) {
|
245
281
|
_this.attributes.notification_daily_send_time = value;
|
246
282
|
});
|
283
|
+
// boolean # Enable integration with Office for the web?
|
247
284
|
(0, _defineProperty2.default)(this, "getOfficeIntegrationEnabled", function () {
|
248
285
|
return _this.attributes.office_integration_enabled;
|
249
286
|
});
|
250
287
|
(0, _defineProperty2.default)(this, "setOfficeIntegrationEnabled", function (value) {
|
251
288
|
_this.attributes.office_integration_enabled = value;
|
252
289
|
});
|
290
|
+
// date-time # Last time the user's password was set
|
253
291
|
(0, _defineProperty2.default)(this, "getPasswordSetAt", function () {
|
254
292
|
return _this.attributes.password_set_at;
|
255
293
|
});
|
256
294
|
(0, _defineProperty2.default)(this, "setPasswordSetAt", function (value) {
|
257
295
|
_this.attributes.password_set_at = value;
|
258
296
|
});
|
297
|
+
// int64 # Number of days to allow user to use the same password
|
259
298
|
(0, _defineProperty2.default)(this, "getPasswordValidityDays", function () {
|
260
299
|
return _this.attributes.password_validity_days;
|
261
300
|
});
|
262
301
|
(0, _defineProperty2.default)(this, "setPasswordValidityDays", function (value) {
|
263
302
|
_this.attributes.password_validity_days = value;
|
264
303
|
});
|
304
|
+
// int64 # Number of public keys associated with this user
|
265
305
|
(0, _defineProperty2.default)(this, "getPublicKeysCount", function () {
|
266
306
|
return _this.attributes.public_keys_count;
|
267
307
|
});
|
268
308
|
(0, _defineProperty2.default)(this, "setPublicKeysCount", function (value) {
|
269
309
|
_this.attributes.public_keys_count = value;
|
270
310
|
});
|
311
|
+
// boolean # Should the user receive admin alerts such a certificate expiration notifications and overages?
|
271
312
|
(0, _defineProperty2.default)(this, "getReceiveAdminAlerts", function () {
|
272
313
|
return _this.attributes.receive_admin_alerts;
|
273
314
|
});
|
274
315
|
(0, _defineProperty2.default)(this, "setReceiveAdminAlerts", function (value) {
|
275
316
|
_this.attributes.receive_admin_alerts = value;
|
276
317
|
});
|
318
|
+
// string # 2FA required setting
|
277
319
|
(0, _defineProperty2.default)(this, "getRequire2fa", function () {
|
278
320
|
return _this.attributes.require_2fa;
|
279
321
|
});
|
280
322
|
(0, _defineProperty2.default)(this, "setRequire2fa", function (value) {
|
281
323
|
_this.attributes.require_2fa = value;
|
282
324
|
});
|
325
|
+
// boolean # Is 2fa active for the user?
|
283
326
|
(0, _defineProperty2.default)(this, "getActive2fa", function () {
|
284
327
|
return _this.attributes.active_2fa;
|
285
328
|
});
|
286
329
|
(0, _defineProperty2.default)(this, "setActive2fa", function (value) {
|
287
330
|
_this.attributes.active_2fa = value;
|
288
331
|
});
|
332
|
+
// boolean # Is a password change required upon next user login?
|
289
333
|
(0, _defineProperty2.default)(this, "getRequirePasswordChange", function () {
|
290
334
|
return _this.attributes.require_password_change;
|
291
335
|
});
|
292
336
|
(0, _defineProperty2.default)(this, "setRequirePasswordChange", function (value) {
|
293
337
|
_this.attributes.require_password_change = value;
|
294
338
|
});
|
339
|
+
// boolean # Is user's password expired?
|
295
340
|
(0, _defineProperty2.default)(this, "getPasswordExpired", function () {
|
296
341
|
return _this.attributes.password_expired;
|
297
342
|
});
|
298
343
|
(0, _defineProperty2.default)(this, "setPasswordExpired", function (value) {
|
299
344
|
_this.attributes.password_expired = value;
|
300
345
|
});
|
346
|
+
// boolean # Can this user access the REST API?
|
301
347
|
(0, _defineProperty2.default)(this, "getRestapiPermission", function () {
|
302
348
|
return _this.attributes.restapi_permission;
|
303
349
|
});
|
304
350
|
(0, _defineProperty2.default)(this, "setRestapiPermission", function (value) {
|
305
351
|
_this.attributes.restapi_permission = value;
|
306
352
|
});
|
353
|
+
// boolean # Does this user manage it's own credentials or is it a shared/bot user?
|
307
354
|
(0, _defineProperty2.default)(this, "getSelfManaged", function () {
|
308
355
|
return _this.attributes.self_managed;
|
309
356
|
});
|
310
357
|
(0, _defineProperty2.default)(this, "setSelfManaged", function (value) {
|
311
358
|
_this.attributes.self_managed = value;
|
312
359
|
});
|
360
|
+
// boolean # Can the user access with SFTP?
|
313
361
|
(0, _defineProperty2.default)(this, "getSftpPermission", function () {
|
314
362
|
return _this.attributes.sftp_permission;
|
315
363
|
});
|
316
364
|
(0, _defineProperty2.default)(this, "setSftpPermission", function (value) {
|
317
365
|
_this.attributes.sftp_permission = value;
|
318
366
|
});
|
367
|
+
// boolean # Is the user an administrator for this site?
|
319
368
|
(0, _defineProperty2.default)(this, "getSiteAdmin", function () {
|
320
369
|
return _this.attributes.site_admin;
|
321
370
|
});
|
322
371
|
(0, _defineProperty2.default)(this, "setSiteAdmin", function (value) {
|
323
372
|
_this.attributes.site_admin = value;
|
324
373
|
});
|
374
|
+
// boolean # Skip Welcome page in the UI?
|
325
375
|
(0, _defineProperty2.default)(this, "getSkipWelcomeScreen", function () {
|
326
376
|
return _this.attributes.skip_welcome_screen;
|
327
377
|
});
|
328
378
|
(0, _defineProperty2.default)(this, "setSkipWelcomeScreen", function (value) {
|
329
379
|
_this.attributes.skip_welcome_screen = value;
|
330
380
|
});
|
381
|
+
// string # SSL required setting
|
331
382
|
(0, _defineProperty2.default)(this, "getSslRequired", function () {
|
332
383
|
return _this.attributes.ssl_required;
|
333
384
|
});
|
334
385
|
(0, _defineProperty2.default)(this, "setSslRequired", function (value) {
|
335
386
|
_this.attributes.ssl_required = value;
|
336
387
|
});
|
388
|
+
// int64 # SSO (Single Sign On) strategy ID for the user, if applicable.
|
337
389
|
(0, _defineProperty2.default)(this, "getSsoStrategyId", function () {
|
338
390
|
return _this.attributes.sso_strategy_id;
|
339
391
|
});
|
340
392
|
(0, _defineProperty2.default)(this, "setSsoStrategyId", function (value) {
|
341
393
|
_this.attributes.sso_strategy_id = value;
|
342
394
|
});
|
395
|
+
// boolean # Is the user subscribed to the newsletter?
|
343
396
|
(0, _defineProperty2.default)(this, "getSubscribeToNewsletter", function () {
|
344
397
|
return _this.attributes.subscribe_to_newsletter;
|
345
398
|
});
|
346
399
|
(0, _defineProperty2.default)(this, "setSubscribeToNewsletter", function (value) {
|
347
400
|
_this.attributes.subscribe_to_newsletter = value;
|
348
401
|
});
|
402
|
+
// boolean # Is this user managed by a SsoStrategy?
|
349
403
|
(0, _defineProperty2.default)(this, "getExternallyManaged", function () {
|
350
404
|
return _this.attributes.externally_managed;
|
351
405
|
});
|
352
406
|
(0, _defineProperty2.default)(this, "setExternallyManaged", function (value) {
|
353
407
|
_this.attributes.externally_managed = value;
|
354
408
|
});
|
409
|
+
// string # User time zone
|
355
410
|
(0, _defineProperty2.default)(this, "getTimeZone", function () {
|
356
411
|
return _this.attributes.time_zone;
|
357
412
|
});
|
358
413
|
(0, _defineProperty2.default)(this, "setTimeZone", function (value) {
|
359
414
|
_this.attributes.time_zone = value;
|
360
415
|
});
|
416
|
+
// string # Type(s) of 2FA methods in use. Will be either `sms`, `totp`, `u2f`, `yubi`, or multiple values sorted alphabetically and joined by an underscore.
|
361
417
|
(0, _defineProperty2.default)(this, "getTypeOf2fa", function () {
|
362
418
|
return _this.attributes.type_of_2fa;
|
363
419
|
});
|
364
420
|
(0, _defineProperty2.default)(this, "setTypeOf2fa", function (value) {
|
365
421
|
_this.attributes.type_of_2fa = value;
|
366
422
|
});
|
423
|
+
// string # Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.) Note that this is not used for API, Desktop, or Web interface.
|
367
424
|
(0, _defineProperty2.default)(this, "getUserRoot", function () {
|
368
425
|
return _this.attributes.user_root;
|
369
426
|
});
|
370
427
|
(0, _defineProperty2.default)(this, "setUserRoot", function (value) {
|
371
428
|
_this.attributes.user_root = value;
|
372
429
|
});
|
430
|
+
// int64 # Number of days remaining until password expires
|
373
431
|
(0, _defineProperty2.default)(this, "getDaysRemainingUntilPasswordExpire", function () {
|
374
432
|
return _this.attributes.days_remaining_until_password_expire;
|
375
433
|
});
|
376
434
|
(0, _defineProperty2.default)(this, "setDaysRemainingUntilPasswordExpire", function (value) {
|
377
435
|
_this.attributes.days_remaining_until_password_expire = value;
|
378
436
|
});
|
437
|
+
// date-time # Password expiration datetime
|
379
438
|
(0, _defineProperty2.default)(this, "getPasswordExpireAt", function () {
|
380
439
|
return _this.attributes.password_expire_at;
|
381
440
|
});
|
382
441
|
(0, _defineProperty2.default)(this, "setPasswordExpireAt", function (value) {
|
383
442
|
_this.attributes.password_expire_at = value;
|
384
443
|
});
|
444
|
+
// file # An image file for your user avatar.
|
385
445
|
(0, _defineProperty2.default)(this, "getAvatarFile", function () {
|
386
446
|
return _this.attributes.avatar_file;
|
387
447
|
});
|
388
448
|
(0, _defineProperty2.default)(this, "setAvatarFile", function (value) {
|
389
449
|
_this.attributes.avatar_file = value;
|
390
450
|
});
|
451
|
+
// boolean # If true, the avatar will be deleted.
|
391
452
|
(0, _defineProperty2.default)(this, "getAvatarDelete", function () {
|
392
453
|
return _this.attributes.avatar_delete;
|
393
454
|
});
|
394
455
|
(0, _defineProperty2.default)(this, "setAvatarDelete", function (value) {
|
395
456
|
_this.attributes.avatar_delete = value;
|
396
457
|
});
|
458
|
+
// string # Used for changing a password on an existing user.
|
397
459
|
(0, _defineProperty2.default)(this, "getChangePassword", function () {
|
398
460
|
return _this.attributes.change_password;
|
399
461
|
});
|
400
462
|
(0, _defineProperty2.default)(this, "setChangePassword", function (value) {
|
401
463
|
_this.attributes.change_password = value;
|
402
464
|
});
|
465
|
+
// string # Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
403
466
|
(0, _defineProperty2.default)(this, "getChangePasswordConfirmation", function () {
|
404
467
|
return _this.attributes.change_password_confirmation;
|
405
468
|
});
|
406
469
|
(0, _defineProperty2.default)(this, "setChangePasswordConfirmation", function (value) {
|
407
470
|
_this.attributes.change_password_confirmation = value;
|
408
471
|
});
|
472
|
+
// string # Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
409
473
|
(0, _defineProperty2.default)(this, "getGrantPermission", function () {
|
410
474
|
return _this.attributes.grant_permission;
|
411
475
|
});
|
412
476
|
(0, _defineProperty2.default)(this, "setGrantPermission", function (value) {
|
413
477
|
_this.attributes.grant_permission = value;
|
414
478
|
});
|
479
|
+
// int64 # Group ID to associate this user with.
|
415
480
|
(0, _defineProperty2.default)(this, "getGroupId", function () {
|
416
481
|
return _this.attributes.group_id;
|
417
482
|
});
|
418
483
|
(0, _defineProperty2.default)(this, "setGroupId", function (value) {
|
419
484
|
_this.attributes.group_id = value;
|
420
485
|
});
|
486
|
+
// string # Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash menthods are MD5, SHA1, and SHA256.
|
421
487
|
(0, _defineProperty2.default)(this, "getImportedPasswordHash", function () {
|
422
488
|
return _this.attributes.imported_password_hash;
|
423
489
|
});
|
424
490
|
(0, _defineProperty2.default)(this, "setImportedPasswordHash", function (value) {
|
425
491
|
_this.attributes.imported_password_hash = value;
|
426
492
|
});
|
493
|
+
// string # User password.
|
427
494
|
(0, _defineProperty2.default)(this, "getPassword", function () {
|
428
495
|
return _this.attributes.password;
|
429
496
|
});
|
430
497
|
(0, _defineProperty2.default)(this, "setPassword", function (value) {
|
431
498
|
_this.attributes.password = value;
|
432
499
|
});
|
500
|
+
// string # Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
433
501
|
(0, _defineProperty2.default)(this, "getPasswordConfirmation", function () {
|
434
502
|
return _this.attributes.password_confirmation;
|
435
503
|
});
|
436
504
|
(0, _defineProperty2.default)(this, "setPasswordConfirmation", function (value) {
|
437
505
|
_this.attributes.password_confirmation = value;
|
438
506
|
});
|
507
|
+
// boolean # Signifies that the user has read all the announcements in the UI.
|
439
508
|
(0, _defineProperty2.default)(this, "getAnnouncementsRead", function () {
|
440
509
|
return _this.attributes.announcements_read;
|
441
510
|
});
|
442
511
|
(0, _defineProperty2.default)(this, "setAnnouncementsRead", function (value) {
|
443
512
|
_this.attributes.announcements_read = value;
|
444
513
|
});
|
514
|
+
// Unlock user who has been locked out due to failed logins
|
445
515
|
(0, _defineProperty2.default)(this, "unlock", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
446
516
|
var params,
|
447
517
|
response,
|
@@ -494,6 +564,7 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
|
|
494
564
|
}
|
495
565
|
}, _callee);
|
496
566
|
})));
|
567
|
+
// Resend user welcome email
|
497
568
|
(0, _defineProperty2.default)(this, "resendWelcomeEmail", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
|
498
569
|
var params,
|
499
570
|
response,
|
@@ -546,6 +617,7 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
|
|
546
617
|
}
|
547
618
|
}, _callee2);
|
548
619
|
})));
|
620
|
+
// Trigger 2FA Reset process for user who has lost access to their existing 2FA methods
|
549
621
|
(0, _defineProperty2.default)(this, "user2faReset", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
|
550
622
|
var params,
|
551
623
|
response,
|
@@ -598,6 +670,51 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
|
|
598
670
|
}
|
599
671
|
}, _callee3);
|
600
672
|
})));
|
673
|
+
// Parameters:
|
674
|
+
// avatar_file - file - An image file for your user avatar.
|
675
|
+
// avatar_delete - boolean - If true, the avatar will be deleted.
|
676
|
+
// change_password - string - Used for changing a password on an existing user.
|
677
|
+
// change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
678
|
+
// email - string - User's email.
|
679
|
+
// grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
680
|
+
// group_id - int64 - Group ID to associate this user with.
|
681
|
+
// group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
682
|
+
// imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash menthods are MD5, SHA1, and SHA256.
|
683
|
+
// password - string - User password.
|
684
|
+
// password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
685
|
+
// announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
|
686
|
+
// allowed_ips - string - A list of allowed IPs if applicable. Newline delimited
|
687
|
+
// attachments_permission - boolean - DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
|
688
|
+
// authenticate_until - string - Scheduled Date/Time at which user will be deactivated
|
689
|
+
// authentication_method - string - How is this user authenticated?
|
690
|
+
// billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices?
|
691
|
+
// bypass_inactive_disable - boolean - Exempt this user from being disabled based on inactivity?
|
692
|
+
// bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists?
|
693
|
+
// dav_permission - boolean - Can the user connect with WebDAV?
|
694
|
+
// disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting.
|
695
|
+
// ftp_permission - boolean - Can the user access with FTP/FTPS?
|
696
|
+
// header_text - string - Text to display to the user in the header of the UI
|
697
|
+
// language - string - Preferred language
|
698
|
+
// notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
|
699
|
+
// name - string - User's full name
|
700
|
+
// company - string - User's company
|
701
|
+
// notes - string - Any internal notes on the user
|
702
|
+
// office_integration_enabled - boolean - Enable integration with Office for the web?
|
703
|
+
// password_validity_days - int64 - Number of days to allow user to use the same password
|
704
|
+
// receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
|
705
|
+
// require_password_change - boolean - Is a password change required upon next user login?
|
706
|
+
// restapi_permission - boolean - Can this user access the REST API?
|
707
|
+
// self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user?
|
708
|
+
// sftp_permission - boolean - Can the user access with SFTP?
|
709
|
+
// site_admin - boolean - Is the user an administrator for this site?
|
710
|
+
// skip_welcome_screen - boolean - Skip Welcome page in the UI?
|
711
|
+
// ssl_required - string - SSL required setting
|
712
|
+
// sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
|
713
|
+
// subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
|
714
|
+
// require_2fa - string - 2FA required setting
|
715
|
+
// time_zone - string - User time zone
|
716
|
+
// user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.) Note that this is not used for API, Desktop, or Web interface.
|
717
|
+
// username - string - User's username
|
601
718
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
|
602
719
|
var params,
|
603
720
|
response,
|
@@ -878,6 +995,25 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
|
|
878
995
|
});
|
879
996
|
this.options = _objectSpread({}, options);
|
880
997
|
});
|
998
|
+
// Parameters:
|
999
|
+
// cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
1000
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
1001
|
+
// sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `authenticate_until`, `active`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
|
1002
|
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
1003
|
+
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
1004
|
+
// filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
1005
|
+
// filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
1006
|
+
// filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
1007
|
+
// filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
1008
|
+
// ids - string - comma-separated list of User IDs
|
1009
|
+
// q[username] - string - List users matching username.
|
1010
|
+
// q[email] - string - List users matching email.
|
1011
|
+
// q[notes] - string - List users matching notes field.
|
1012
|
+
// q[admin] - string - If `true`, list only admin users.
|
1013
|
+
// q[allowed_ips] - string - If set, list only users with overridden allowed IP setting.
|
1014
|
+
// q[password_validity_days] - string - If set, list only users with overridden password validity days setting.
|
1015
|
+
// q[ssl_required] - string - If set, list only users with overridden SSL required setting.
|
1016
|
+
// search - string - Searches for partial matches of name, username, or email.
|
881
1017
|
(0, _defineProperty2.default)(User, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
|
882
1018
|
var _response$data;
|
883
1019
|
var params,
|
@@ -931,6 +1067,8 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
|
|
931
1067
|
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
932
1068
|
return User.list(params, options);
|
933
1069
|
});
|
1070
|
+
// Parameters:
|
1071
|
+
// id (required) - int64 - User ID.
|
934
1072
|
(0, _defineProperty2.default)(User, "find", /*#__PURE__*/function () {
|
935
1073
|
var _ref9 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7(id) {
|
936
1074
|
var params,
|
@@ -981,6 +1119,51 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
|
|
981
1119
|
var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
|
982
1120
|
return User.find(id, params, options);
|
983
1121
|
});
|
1122
|
+
// Parameters:
|
1123
|
+
// avatar_file - file - An image file for your user avatar.
|
1124
|
+
// avatar_delete - boolean - If true, the avatar will be deleted.
|
1125
|
+
// change_password - string - Used for changing a password on an existing user.
|
1126
|
+
// change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
1127
|
+
// email - string - User's email.
|
1128
|
+
// grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
1129
|
+
// group_id - int64 - Group ID to associate this user with.
|
1130
|
+
// group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
1131
|
+
// imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash menthods are MD5, SHA1, and SHA256.
|
1132
|
+
// password - string - User password.
|
1133
|
+
// password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
1134
|
+
// announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
|
1135
|
+
// allowed_ips - string - A list of allowed IPs if applicable. Newline delimited
|
1136
|
+
// attachments_permission - boolean - DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
|
1137
|
+
// authenticate_until - string - Scheduled Date/Time at which user will be deactivated
|
1138
|
+
// authentication_method - string - How is this user authenticated?
|
1139
|
+
// billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices?
|
1140
|
+
// bypass_inactive_disable - boolean - Exempt this user from being disabled based on inactivity?
|
1141
|
+
// bypass_site_allowed_ips - boolean - Allow this user to skip site-wide IP blacklists?
|
1142
|
+
// dav_permission - boolean - Can the user connect with WebDAV?
|
1143
|
+
// disabled - boolean - Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting.
|
1144
|
+
// ftp_permission - boolean - Can the user access with FTP/FTPS?
|
1145
|
+
// header_text - string - Text to display to the user in the header of the UI
|
1146
|
+
// language - string - Preferred language
|
1147
|
+
// notification_daily_send_time - int64 - Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
|
1148
|
+
// name - string - User's full name
|
1149
|
+
// company - string - User's company
|
1150
|
+
// notes - string - Any internal notes on the user
|
1151
|
+
// office_integration_enabled - boolean - Enable integration with Office for the web?
|
1152
|
+
// password_validity_days - int64 - Number of days to allow user to use the same password
|
1153
|
+
// receive_admin_alerts - boolean - Should the user receive admin alerts such a certificate expiration notifications and overages?
|
1154
|
+
// require_password_change - boolean - Is a password change required upon next user login?
|
1155
|
+
// restapi_permission - boolean - Can this user access the REST API?
|
1156
|
+
// self_managed - boolean - Does this user manage it's own credentials or is it a shared/bot user?
|
1157
|
+
// sftp_permission - boolean - Can the user access with SFTP?
|
1158
|
+
// site_admin - boolean - Is the user an administrator for this site?
|
1159
|
+
// skip_welcome_screen - boolean - Skip Welcome page in the UI?
|
1160
|
+
// ssl_required - string - SSL required setting
|
1161
|
+
// sso_strategy_id - int64 - SSO (Single Sign On) strategy ID for the user, if applicable.
|
1162
|
+
// subscribe_to_newsletter - boolean - Is the user subscribed to the newsletter?
|
1163
|
+
// require_2fa - string - 2FA required setting
|
1164
|
+
// time_zone - string - User time zone
|
1165
|
+
// user_root - string - Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.) Note that this is not used for API, Desktop, or Web interface.
|
1166
|
+
// username - string - User's username
|
984
1167
|
(0, _defineProperty2.default)(User, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8() {
|
985
1168
|
var params,
|
986
1169
|
options,
|