Skip to content

Commit 1dc5109

Browse files
[Bot] push changes from Files.com
1 parent 6097d21 commit 1dc5109

File tree

11 files changed

+865
-89
lines changed

11 files changed

+865
-89
lines changed

_VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.2.584
1+
1.2.585
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# DesktopConfigurationProfile
2+
3+
## Example DesktopConfigurationProfile Object
4+
5+
```
6+
{
7+
"id": 1,
8+
"name": "North America Desktop Profile",
9+
"workspace_id": 1,
10+
"use_for_all_users": true,
11+
"mount_mappings": {
12+
"key": "example value"
13+
}
14+
}
15+
```
16+
17+
* `id` (int64): Desktop Configuration Profile ID
18+
* `name` (string): Profile name
19+
* `workspace_id` (int64): Workspace ID
20+
* `use_for_all_users` (boolean): Whether this profile applies to all users in the Workspace by default
21+
* `mount_mappings` (object): Mount point mappings for the desktop app. Keys are mount points (e.g. drive letters) and values are paths in Files.com that the mount points map to.
22+
23+
---
24+
25+
## List Desktop Configuration Profiles
26+
27+
```
28+
await DesktopConfigurationProfile.list
29+
```
30+
31+
32+
### Parameters
33+
34+
* `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.
35+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
37+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
38+
39+
---
40+
41+
## Show Desktop Configuration Profile
42+
43+
```
44+
await DesktopConfigurationProfile.find(id)
45+
```
46+
47+
48+
### Parameters
49+
50+
* `id` (int64): Required - Desktop Configuration Profile ID.
51+
52+
---
53+
54+
## Create Desktop Configuration Profile
55+
56+
```
57+
await DesktopConfigurationProfile.create({
58+
'name': "North America Desktop Profile",
59+
'mount_mappings': {"key":"example value"},
60+
'workspace_id': 1,
61+
'use_for_all_users': false,
62+
})
63+
```
64+
65+
66+
### Parameters
67+
68+
* `name` (string): Required - Profile name
69+
* `mount_mappings` (object): Required - Mount point mappings for the desktop app. Keys are mount points (e.g. drive letters) and values are paths in Files.com that the mount points map to.
70+
* `workspace_id` (int64): Workspace ID
71+
* `use_for_all_users` (boolean): Whether this profile applies to all users in the Workspace by default
72+
73+
---
74+
75+
## Update Desktop Configuration Profile
76+
77+
```
78+
const desktop_configuration_profile = await DesktopConfigurationProfile.find(id)
79+
80+
await desktop_configuration_profile.update({
81+
'name': "North America Desktop Profile",
82+
'workspace_id': 1,
83+
'mount_mappings': {"key":"example value"},
84+
'use_for_all_users': false,
85+
})
86+
```
87+
88+
### Parameters
89+
90+
* `id` (int64): Required - Desktop Configuration Profile ID.
91+
* `name` (string): Profile name
92+
* `workspace_id` (int64): Workspace ID
93+
* `mount_mappings` (object): Mount point mappings for the desktop app. Keys are mount points (e.g. drive letters) and values are paths in Files.com that the mount points map to.
94+
* `use_for_all_users` (boolean): Whether this profile applies to all users in the Workspace by default
95+
96+
### Example Response
97+
98+
```json
99+
{
100+
"id": 1,
101+
"name": "North America Desktop Profile",
102+
"workspace_id": 1,
103+
"use_for_all_users": true,
104+
"mount_mappings": {
105+
"key": "example value"
106+
}
107+
}
108+
```
109+
110+
---
111+
112+
## Delete Desktop Configuration Profile
113+
114+
```
115+
const desktop_configuration_profile = await DesktopConfigurationProfile.find(id)
116+
117+
await desktop_configuration_profile.delete()
118+
```
119+
120+
### Parameters
121+
122+
* `id` (int64): Required - Desktop Configuration Profile ID.
123+

docs/models/Site.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,7 @@
239239
"dav_permission": true,
240240
"disabled": true,
241241
"disabled_expired_or_inactive": true,
242+
"desktop_configuration_profile_id": 1,
242243
"email": "john.doe@files.com",
243244
"filesystem_layout": "site_root",
244245
"first_login_at": "2000-01-01T01:00:00Z",

docs/models/User.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"dav_permission": true,
2424
"disabled": true,
2525
"disabled_expired_or_inactive": true,
26+
"desktop_configuration_profile_id": 1,
2627
"email": "john.doe@files.com",
2728
"filesystem_layout": "site_root",
2829
"first_login_at": "2000-01-01T01:00:00Z",
@@ -99,6 +100,7 @@
99100
* `dav_permission` (boolean): Can the user connect with WebDAV?
100101
* `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 or schedule to be deactivated after specific date.
101102
* `disabled_expired_or_inactive` (boolean): Computed property that returns true if user disabled or expired or inactive.
103+
* `desktop_configuration_profile_id` (int64): Desktop Configuration Profile ID assigned directly to this user, if any.
102104
* `email` (email): User email address
103105
* `filesystem_layout` (string): File system layout
104106
* `first_login_at` (date-time): User's first login time
@@ -226,6 +228,7 @@ await User.create({
226228
'bypass_user_lifecycle_rules': false,
227229
'bypass_site_allowed_ips': false,
228230
'dav_permission': true,
231+
'desktop_configuration_profile_id': 1,
229232
'disabled': true,
230233
'filesystem_layout': "site_root",
231234
'ftp_permission': true,
@@ -285,6 +288,7 @@ await User.create({
285288
* `bypass_user_lifecycle_rules` (boolean): Exempt this user from user lifecycle rules?
286289
* `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
287290
* `dav_permission` (boolean): Can the user connect with WebDAV?
291+
* `desktop_configuration_profile_id` (int64): Desktop Configuration Profile ID assigned directly to this user, if any.
288292
* `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 or schedule to be deactivated after specific date.
289293
* `filesystem_layout` (string): File system layout
290294
* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
@@ -385,6 +389,7 @@ await user.update({
385389
'bypass_user_lifecycle_rules': false,
386390
'bypass_site_allowed_ips': false,
387391
'dav_permission': true,
392+
'desktop_configuration_profile_id': 1,
388393
'disabled': true,
389394
'filesystem_layout': "site_root",
390395
'ftp_permission': true,
@@ -445,6 +450,7 @@ await user.update({
445450
* `bypass_user_lifecycle_rules` (boolean): Exempt this user from user lifecycle rules?
446451
* `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
447452
* `dav_permission` (boolean): Can the user connect with WebDAV?
453+
* `desktop_configuration_profile_id` (int64): Desktop Configuration Profile ID assigned directly to this user, if any.
448454
* `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 or schedule to be deactivated after specific date.
449455
* `filesystem_layout` (string): File system layout
450456
* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
@@ -503,6 +509,7 @@ await user.update({
503509
"dav_permission": true,
504510
"disabled": true,
505511
"disabled_expired_or_inactive": true,
512+
"desktop_configuration_profile_id": 1,
506513
"email": "john.doe@files.com",
507514
"filesystem_layout": "site_root",
508515
"first_login_at": "2000-01-01T01:00:00Z",

lib/Files.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var apiKey;
1212
var baseUrl = 'https://app.files.com';
1313
var sessionId = null;
1414
var language = null;
15-
var version = '1.2.584';
15+
var version = '1.2.585';
1616
var userAgent = "Files.com JavaScript SDK v".concat(version);
1717
var logLevel = _Logger.LogLevel.INFO;
1818
var debugRequest = false;

0 commit comments

Comments
 (0)