files.com 1.0.77 → 1.0.82
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/api_key.md +25 -25
- data/docs/permission.md +1 -1
- data/docs/remote_server.md +8 -8
- data/docs/site.md +4 -0
- data/docs/user.md +6 -8
- data/docs/user_request.md +93 -0
- data/lib/files.com.rb +1 -0
- data/lib/files.com/models/api_key.rb +17 -17
- data/lib/files.com/models/permission.rb +1 -1
- data/lib/files.com/models/remote_server.rb +4 -4
- data/lib/files.com/models/site.rb +6 -0
- data/lib/files.com/models/user.rb +5 -5
- data/lib/files.com/models/user_request.rb +127 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 291ed1937c452b1f0b2949b0188f3eee3083fba6a49ea3ce42e664b89bcc49c3
|
4
|
+
data.tar.gz: e8af65f7aad9a09e547184bac4caa3e53ac506dbf1462ae13a91bb461302072b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0e884b02521b63b92fae0107df8d9853dee8518eedab399c3c055c5737851bdb7211a77c74524a447072aed6c27df29a76423817696ea04b218380a1647e74f5
|
7
|
+
data.tar.gz: f6f41719640ef692004aec3035c51366430d6a3ea1108c4ca383488c640a688f5bad37c127280e119807e3e5c91aca97484cc0cb37db5cb530207f7040c173e7
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.82
|
data/docs/api_key.md
CHANGED
@@ -24,7 +24,7 @@
|
|
24
24
|
* `key` (string): API Key actual key string
|
25
25
|
* `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.
|
26
26
|
* `name` (string): Internal name for the API Key. For your use.
|
27
|
-
* `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.
|
27
|
+
* `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.
|
28
28
|
* `platform` (string): If this API key represents a Desktop app, what platform was it created on?
|
29
29
|
* `user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
|
30
30
|
|
@@ -78,18 +78,18 @@ Files::ApiKey.find(id)
|
|
78
78
|
```
|
79
79
|
Files::ApiKey.create(
|
80
80
|
user_id: 1,
|
81
|
-
name: "My Key",
|
82
|
-
|
83
|
-
|
81
|
+
name: "My Main API Key",
|
82
|
+
expires_at: "2000-01-01T01:00:00Z",
|
83
|
+
permission_set: "full"
|
84
84
|
)
|
85
85
|
```
|
86
86
|
|
87
87
|
### Parameters
|
88
88
|
|
89
89
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
90
|
-
* `name` (string): Internal name for
|
91
|
-
* `
|
92
|
-
* `
|
90
|
+
* `name` (string): Internal name for the API Key. For your use.
|
91
|
+
* `expires_at` (string): API Key expiration date
|
92
|
+
* `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.
|
93
93
|
|
94
94
|
|
95
95
|
---
|
@@ -98,17 +98,17 @@ Files::ApiKey.create(
|
|
98
98
|
|
99
99
|
```
|
100
100
|
Files::ApiKey.update_current(
|
101
|
-
|
102
|
-
|
103
|
-
|
101
|
+
expires_at: "2000-01-01T01:00:00Z",
|
102
|
+
name: "My Main API Key",
|
103
|
+
permission_set: "full"
|
104
104
|
)
|
105
105
|
```
|
106
106
|
|
107
107
|
### Parameters
|
108
108
|
|
109
|
-
* `
|
110
|
-
* `
|
111
|
-
* `
|
109
|
+
* `expires_at` (string): API Key expiration date
|
110
|
+
* `name` (string): Internal name for the API Key. For your use.
|
111
|
+
* `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.
|
112
112
|
|
113
113
|
|
114
114
|
---
|
@@ -117,18 +117,18 @@ Files::ApiKey.update_current(
|
|
117
117
|
|
118
118
|
```
|
119
119
|
Files::ApiKey.update(id,
|
120
|
-
name: "My Key",
|
121
|
-
|
122
|
-
|
120
|
+
name: "My Main API Key",
|
121
|
+
expires_at: "2000-01-01T01:00:00Z",
|
122
|
+
permission_set: "full"
|
123
123
|
)
|
124
124
|
```
|
125
125
|
|
126
126
|
### Parameters
|
127
127
|
|
128
128
|
* `id` (int64): Required - Api Key ID.
|
129
|
-
* `name` (string): Internal name for
|
130
|
-
* `
|
131
|
-
* `
|
129
|
+
* `name` (string): Internal name for the API Key. For your use.
|
130
|
+
* `expires_at` (string): API Key expiration date
|
131
|
+
* `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.
|
132
132
|
|
133
133
|
|
134
134
|
---
|
@@ -161,18 +161,18 @@ Files::ApiKey.delete(id)
|
|
161
161
|
api_key = Files::ApiKey.list_for(path).first
|
162
162
|
|
163
163
|
api_key.update(
|
164
|
-
name: "My Key",
|
165
|
-
|
166
|
-
|
164
|
+
name: "My Main API Key",
|
165
|
+
expires_at: "2000-01-01T01:00:00Z",
|
166
|
+
permission_set: "full"
|
167
167
|
)
|
168
168
|
```
|
169
169
|
|
170
170
|
### Parameters
|
171
171
|
|
172
172
|
* `id` (int64): Required - Api Key ID.
|
173
|
-
* `name` (string): Internal name for
|
174
|
-
* `
|
175
|
-
* `
|
173
|
+
* `name` (string): Internal name for the API Key. For your use.
|
174
|
+
* `expires_at` (string): API Key expiration date
|
175
|
+
* `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.
|
176
176
|
|
177
177
|
|
178
178
|
---
|
data/docs/permission.md
CHANGED
@@ -68,7 +68,7 @@ Files::Permission.create(path,
|
|
68
68
|
|
69
69
|
* `group_id` (int64): Group ID
|
70
70
|
* `path` (string): Folder path
|
71
|
-
* `permission` (string): Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `
|
71
|
+
* `permission` (string): Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
72
72
|
* `recursive` (boolean): Apply to subfolders recursively?
|
73
73
|
* `user_id` (int64): User ID. Provide `username` or `user_id`
|
74
74
|
* `username` (string): User username. Provide `username` or `user_id`
|
data/docs/remote_server.md
CHANGED
@@ -29,7 +29,7 @@
|
|
29
29
|
"auth_setup_link": "auth/:provider",
|
30
30
|
"auth_status": "in_setup",
|
31
31
|
"auth_account_name": "me@example.com",
|
32
|
-
"one_drive_account_type": "
|
32
|
+
"one_drive_account_type": "personal"
|
33
33
|
}
|
34
34
|
```
|
35
35
|
|
@@ -58,7 +58,7 @@
|
|
58
58
|
* `auth_setup_link` (string): Returns link to login with an Oauth provider
|
59
59
|
* `auth_status` (string): Either `in_setup` or `complete`
|
60
60
|
* `auth_account_name` (string): Describes the authorized account
|
61
|
-
* `one_drive_account_type` (string): Either
|
61
|
+
* `one_drive_account_type` (string): Either personal or business_other account types
|
62
62
|
* `aws_access_key` (string): AWS Access Key.
|
63
63
|
* `aws_secret_key` (string): AWS secret key.
|
64
64
|
* `password` (string): Password if needed.
|
@@ -130,7 +130,7 @@ Files::RemoteServer.create(
|
|
130
130
|
rackspace_username: "rackspaceuser",
|
131
131
|
rackspace_region: "dfw",
|
132
132
|
rackspace_container: "my-container",
|
133
|
-
one_drive_account_type: "
|
133
|
+
one_drive_account_type: "personal"
|
134
134
|
)
|
135
135
|
```
|
136
136
|
|
@@ -167,7 +167,7 @@ Files::RemoteServer.create(
|
|
167
167
|
* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
|
168
168
|
* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
|
169
169
|
* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
|
170
|
-
* `one_drive_account_type` (string): Either
|
170
|
+
* `one_drive_account_type` (string): Either personal or business_other account types
|
171
171
|
|
172
172
|
|
173
173
|
---
|
@@ -197,7 +197,7 @@ Files::RemoteServer.update(id,
|
|
197
197
|
rackspace_username: "rackspaceuser",
|
198
198
|
rackspace_region: "dfw",
|
199
199
|
rackspace_container: "my-container",
|
200
|
-
one_drive_account_type: "
|
200
|
+
one_drive_account_type: "personal"
|
201
201
|
)
|
202
202
|
```
|
203
203
|
|
@@ -235,7 +235,7 @@ Files::RemoteServer.update(id,
|
|
235
235
|
* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
|
236
236
|
* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
|
237
237
|
* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
|
238
|
-
* `one_drive_account_type` (string): Either
|
238
|
+
* `one_drive_account_type` (string): Either personal or business_other account types
|
239
239
|
|
240
240
|
|
241
241
|
---
|
@@ -280,7 +280,7 @@ remote_server.update(
|
|
280
280
|
rackspace_username: "rackspaceuser",
|
281
281
|
rackspace_region: "dfw",
|
282
282
|
rackspace_container: "my-container",
|
283
|
-
one_drive_account_type: "
|
283
|
+
one_drive_account_type: "personal"
|
284
284
|
)
|
285
285
|
```
|
286
286
|
|
@@ -318,7 +318,7 @@ remote_server.update(
|
|
318
318
|
* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
|
319
319
|
* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
|
320
320
|
* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
|
321
|
-
* `one_drive_account_type` (string): Either
|
321
|
+
* `one_drive_account_type` (string): Either personal or business_other account types
|
322
322
|
|
323
323
|
|
324
324
|
---
|
data/docs/site.md
CHANGED
@@ -106,6 +106,7 @@
|
|
106
106
|
"user_lockout_lock_period": 1,
|
107
107
|
"user_lockout_tries": 1,
|
108
108
|
"user_lockout_within": 6,
|
109
|
+
"user_requests_enabled": true,
|
109
110
|
"welcome_custom_text": "Welcome to my site!",
|
110
111
|
"welcome_email_cc": "",
|
111
112
|
"welcome_email_enabled": true,
|
@@ -217,6 +218,7 @@
|
|
217
218
|
* `user_lockout_lock_period` (int64): How many hours to lock user out for failed password?
|
218
219
|
* `user_lockout_tries` (int64): Number of login tries within `user_lockout_within` hours before users are locked out
|
219
220
|
* `user_lockout_within` (int64): Number of hours for user lockout window
|
221
|
+
* `user_requests_enabled` (boolean): Enable User Requests feature
|
220
222
|
* `welcome_custom_text` (string): Custom text send in user welcome email
|
221
223
|
* `welcome_email_cc` (email): Include this email in welcome emails if enabled
|
222
224
|
* `welcome_email_enabled` (boolean): Will the welcome email be sent to new users?
|
@@ -298,6 +300,7 @@ Files::Site.update(
|
|
298
300
|
non_sso_groups_allowed: true,
|
299
301
|
non_sso_users_allowed: true,
|
300
302
|
sharing_enabled: true,
|
303
|
+
user_requests_enabled: true,
|
301
304
|
allowed_2fa_method_sms: true,
|
302
305
|
allowed_2fa_method_u2f: true,
|
303
306
|
allowed_2fa_method_totp: true,
|
@@ -389,6 +392,7 @@ Files::Site.update(
|
|
389
392
|
* `non_sso_groups_allowed` (boolean): If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
|
390
393
|
* `non_sso_users_allowed` (boolean): If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
|
391
394
|
* `sharing_enabled` (boolean): Allow bundle creation
|
395
|
+
* `user_requests_enabled` (boolean): Enable User Requests feature
|
392
396
|
* `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
|
393
397
|
* `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
|
394
398
|
* `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?
|
data/docs/user.md
CHANGED
@@ -23,9 +23,7 @@
|
|
23
23
|
"disabled": true,
|
24
24
|
"email": "john.doe@files.com",
|
25
25
|
"ftp_permission": true,
|
26
|
-
"group_ids":
|
27
|
-
|
28
|
-
],
|
26
|
+
"group_ids": "",
|
29
27
|
"header_text": "User-specific message.",
|
30
28
|
"language": "en",
|
31
29
|
"last_login_at": "2000-01-01T01:00:00Z",
|
@@ -72,7 +70,7 @@
|
|
72
70
|
* `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.
|
73
71
|
* `email` (email): User email address
|
74
72
|
* `ftp_permission` (boolean): Can the user access with FTP/FTPS?
|
75
|
-
* `group_ids` (
|
73
|
+
* `group_ids` (string): Comma-separated list of group IDs of which this user is a member
|
76
74
|
* `header_text` (string): Text to display to the user in the header of the UI
|
77
75
|
* `language` (string): Preferred language
|
78
76
|
* `last_login_at` (date-time): User's last login time
|
@@ -103,7 +101,7 @@
|
|
103
101
|
* `avatar_delete` (boolean): If true, the avatar will be deleted.
|
104
102
|
* `change_password` (string): Used for changing a password on an existing user.
|
105
103
|
* `change_password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
106
|
-
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `
|
104
|
+
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
107
105
|
* `group_id` (int64): Group ID to associate this user with.
|
108
106
|
* `password` (string): User password.
|
109
107
|
* `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
@@ -199,7 +197,7 @@ Files::User.create(
|
|
199
197
|
* `change_password` (string): Used for changing a password on an existing user.
|
200
198
|
* `change_password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
201
199
|
* `email` (string): User's email.
|
202
|
-
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `
|
200
|
+
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
203
201
|
* `group_id` (int64): Group ID to associate this user with.
|
204
202
|
* `group_ids` (string): A list of group ids to associate this user with. Comma delimited.
|
205
203
|
* `password` (string): User password.
|
@@ -324,7 +322,7 @@ Files::User.update(id,
|
|
324
322
|
* `change_password` (string): Used for changing a password on an existing user.
|
325
323
|
* `change_password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
326
324
|
* `email` (string): User's email.
|
327
|
-
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `
|
325
|
+
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
328
326
|
* `group_id` (int64): Group ID to associate this user with.
|
329
327
|
* `group_ids` (string): A list of group ids to associate this user with. Comma delimited.
|
330
328
|
* `password` (string): User password.
|
@@ -470,7 +468,7 @@ user.update(
|
|
470
468
|
* `change_password` (string): Used for changing a password on an existing user.
|
471
469
|
* `change_password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
472
470
|
* `email` (string): User's email.
|
473
|
-
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `
|
471
|
+
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
474
472
|
* `group_id` (int64): Group ID to associate this user with.
|
475
473
|
* `group_ids` (string): A list of group ids to associate this user with. Comma delimited.
|
476
474
|
* `password` (string): User password.
|
@@ -0,0 +1,93 @@
|
|
1
|
+
# UserRequest
|
2
|
+
|
3
|
+
## Example UserRequest Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"name": "John Doe",
|
8
|
+
"email": "john.doe@files.com",
|
9
|
+
"details": "Changed Departments"
|
10
|
+
}
|
11
|
+
```
|
12
|
+
|
13
|
+
* `name` (string): User's full name
|
14
|
+
* `email` (email): User email address
|
15
|
+
* `details` (string): Details of the user's request
|
16
|
+
|
17
|
+
|
18
|
+
---
|
19
|
+
|
20
|
+
## List User Requests
|
21
|
+
|
22
|
+
```
|
23
|
+
Files::UserRequest.list(
|
24
|
+
page: 1,
|
25
|
+
per_page: 1
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
29
|
+
### Parameters
|
30
|
+
|
31
|
+
* `page` (int64): Current page number.
|
32
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
33
|
+
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
34
|
+
|
35
|
+
|
36
|
+
---
|
37
|
+
|
38
|
+
## Show User Request
|
39
|
+
|
40
|
+
```
|
41
|
+
Files::UserRequest.find(id)
|
42
|
+
```
|
43
|
+
|
44
|
+
### Parameters
|
45
|
+
|
46
|
+
* `id` (int64): Required - User Request ID.
|
47
|
+
|
48
|
+
|
49
|
+
---
|
50
|
+
|
51
|
+
## Create User Request
|
52
|
+
|
53
|
+
```
|
54
|
+
Files::UserRequest.create(
|
55
|
+
name: "name",
|
56
|
+
email: "email",
|
57
|
+
details: "details"
|
58
|
+
)
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
* `name` (string): Required - Name of user requested
|
64
|
+
* `email` (string): Required - Email of user requested
|
65
|
+
* `details` (string): Required - Details of the user request
|
66
|
+
|
67
|
+
|
68
|
+
---
|
69
|
+
|
70
|
+
## Delete User Request
|
71
|
+
|
72
|
+
```
|
73
|
+
Files::UserRequest.delete(id)
|
74
|
+
```
|
75
|
+
|
76
|
+
### Parameters
|
77
|
+
|
78
|
+
* `id` (int64): Required - User Request ID.
|
79
|
+
|
80
|
+
|
81
|
+
---
|
82
|
+
|
83
|
+
## Delete User Request
|
84
|
+
|
85
|
+
```
|
86
|
+
user_request = Files::UserRequest.list_for(path).first
|
87
|
+
|
88
|
+
user_request.delete
|
89
|
+
```
|
90
|
+
|
91
|
+
### Parameters
|
92
|
+
|
93
|
+
* `id` (int64): Required - User Request ID.
|
data/lib/files.com.rb
CHANGED
@@ -75,6 +75,7 @@ require "files.com/models/usage_daily_snapshot"
|
|
75
75
|
require "files.com/models/usage_snapshot"
|
76
76
|
require "files.com/models/user"
|
77
77
|
require "files.com/models/user_cipher_use"
|
78
|
+
require "files.com/models/user_request"
|
78
79
|
|
79
80
|
require "files.com/models/dir"
|
80
81
|
require "files.com/models/file_utils"
|
@@ -68,7 +68,7 @@ module Files
|
|
68
68
|
@attributes[:name] = value
|
69
69
|
end
|
70
70
|
|
71
|
-
# 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.
|
71
|
+
# 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.
|
72
72
|
def permission_set
|
73
73
|
@attributes[:permission_set]
|
74
74
|
end
|
@@ -96,17 +96,17 @@ module Files
|
|
96
96
|
end
|
97
97
|
|
98
98
|
# Parameters:
|
99
|
-
# name - string - Internal name for
|
100
|
-
#
|
101
|
-
#
|
99
|
+
# name - string - Internal name for the API Key. For your use.
|
100
|
+
# expires_at - string - API Key expiration date
|
101
|
+
# 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.
|
102
102
|
def update(params = {})
|
103
103
|
params ||= {}
|
104
104
|
params[:id] = @attributes[:id]
|
105
105
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
106
106
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
107
107
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
108
|
-
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
|
109
108
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
|
109
|
+
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
|
110
110
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
111
111
|
|
112
112
|
Api.send_request("/api_keys/#{@attributes[:id]}", :patch, params, @options)
|
@@ -179,43 +179,43 @@ module Files
|
|
179
179
|
|
180
180
|
# Parameters:
|
181
181
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
182
|
-
# name - string - Internal name for
|
183
|
-
#
|
184
|
-
#
|
182
|
+
# name - string - Internal name for the API Key. For your use.
|
183
|
+
# expires_at - string - API Key expiration date
|
184
|
+
# 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.
|
185
185
|
def self.create(params = {}, options = {})
|
186
186
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
187
187
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
188
|
-
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
|
189
188
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
|
189
|
+
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
|
190
190
|
|
191
191
|
response, options = Api.send_request("/api_keys", :post, params, options)
|
192
192
|
ApiKey.new(response.data, options)
|
193
193
|
end
|
194
194
|
|
195
195
|
# Parameters:
|
196
|
-
#
|
197
|
-
#
|
198
|
-
#
|
196
|
+
# expires_at - string - API Key expiration date
|
197
|
+
# name - string - Internal name for the API Key. For your use.
|
198
|
+
# 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.
|
199
199
|
def self.update_current(params = {}, options = {})
|
200
|
+
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
|
200
201
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
201
202
|
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
|
202
|
-
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
|
203
203
|
|
204
204
|
response, options = Api.send_request("/api_key", :patch, params, options)
|
205
205
|
ApiKey.new(response.data, options)
|
206
206
|
end
|
207
207
|
|
208
208
|
# Parameters:
|
209
|
-
# name - string - Internal name for
|
210
|
-
#
|
211
|
-
#
|
209
|
+
# name - string - Internal name for the API Key. For your use.
|
210
|
+
# expires_at - string - API Key expiration date
|
211
|
+
# 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.
|
212
212
|
def self.update(id, params = {}, options = {})
|
213
213
|
params ||= {}
|
214
214
|
params[:id] = id
|
215
215
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
216
216
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
217
|
-
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
|
218
217
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
|
218
|
+
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
|
219
219
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
220
220
|
|
221
221
|
response, options = Api.send_request("/api_keys/#{params[:id]}", :patch, params, options)
|
@@ -121,7 +121,7 @@ module Files
|
|
121
121
|
# Parameters:
|
122
122
|
# group_id - int64 - Group ID
|
123
123
|
# path - string - Folder path
|
124
|
-
# permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `
|
124
|
+
# permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
125
125
|
# recursive - boolean - Apply to subfolders recursively?
|
126
126
|
# user_id - int64 - User ID. Provide `username` or `user_id`
|
127
127
|
# username - string - User username. Provide `username` or `user_id`
|
@@ -234,7 +234,7 @@ module Files
|
|
234
234
|
@attributes[:auth_account_name] = value
|
235
235
|
end
|
236
236
|
|
237
|
-
# string - Either
|
237
|
+
# string - Either personal or business_other account types
|
238
238
|
def one_drive_account_type
|
239
239
|
@attributes[:one_drive_account_type]
|
240
240
|
end
|
@@ -374,7 +374,7 @@ module Files
|
|
374
374
|
# rackspace_username - string - Rackspace username used to login to the Rackspace Cloud Control Panel.
|
375
375
|
# rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
|
376
376
|
# rackspace_container - string - The name of the container (top level directory) where files will sync.
|
377
|
-
# one_drive_account_type - string - Either
|
377
|
+
# one_drive_account_type - string - Either personal or business_other account types
|
378
378
|
def update(params = {})
|
379
379
|
params ||= {}
|
380
380
|
params[:id] = @attributes[:id]
|
@@ -506,7 +506,7 @@ module Files
|
|
506
506
|
# rackspace_username - string - Rackspace username used to login to the Rackspace Cloud Control Panel.
|
507
507
|
# rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
|
508
508
|
# rackspace_container - string - The name of the container (top level directory) where files will sync.
|
509
|
-
# one_drive_account_type - string - Either
|
509
|
+
# one_drive_account_type - string - Either personal or business_other account types
|
510
510
|
def self.create(params = {}, options = {})
|
511
511
|
raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params.dig(:aws_access_key) and !params.dig(:aws_access_key).is_a?(String)
|
512
512
|
raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params.dig(:aws_secret_key) and !params.dig(:aws_secret_key).is_a?(String)
|
@@ -576,7 +576,7 @@ module Files
|
|
576
576
|
# rackspace_username - string - Rackspace username used to login to the Rackspace Cloud Control Panel.
|
577
577
|
# rackspace_region - string - Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
|
578
578
|
# rackspace_container - string - The name of the container (top level directory) where files will sync.
|
579
|
-
# one_drive_account_type - string - Either
|
579
|
+
# one_drive_account_type - string - Either personal or business_other account types
|
580
580
|
def self.update(id, params = {}, options = {})
|
581
581
|
params ||= {}
|
582
582
|
params[:id] = id
|
@@ -519,6 +519,11 @@ module Files
|
|
519
519
|
@attributes[:user_lockout_within]
|
520
520
|
end
|
521
521
|
|
522
|
+
# boolean - Enable User Requests feature
|
523
|
+
def user_requests_enabled
|
524
|
+
@attributes[:user_requests_enabled]
|
525
|
+
end
|
526
|
+
|
522
527
|
# string - Custom text send in user welcome email
|
523
528
|
def welcome_custom_text
|
524
529
|
@attributes[:welcome_custom_text]
|
@@ -611,6 +616,7 @@ module Files
|
|
611
616
|
# non_sso_groups_allowed - boolean - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
|
612
617
|
# non_sso_users_allowed - boolean - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
|
613
618
|
# sharing_enabled - boolean - Allow bundle creation
|
619
|
+
# user_requests_enabled - boolean - Enable User Requests feature
|
614
620
|
# allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed?
|
615
621
|
# allowed_2fa_method_u2f - boolean - Is U2F two factor authentication allowed?
|
616
622
|
# allowed_2fa_method_totp - boolean - Is TOTP two factor authentication allowed?
|
@@ -158,7 +158,7 @@ module Files
|
|
158
158
|
@attributes[:ftp_permission] = value
|
159
159
|
end
|
160
160
|
|
161
|
-
#
|
161
|
+
# string - Comma-separated list of group IDs of which this user is a member
|
162
162
|
def group_ids
|
163
163
|
@attributes[:group_ids]
|
164
164
|
end
|
@@ -437,7 +437,7 @@ module Files
|
|
437
437
|
@attributes[:change_password_confirmation] = value
|
438
438
|
end
|
439
439
|
|
440
|
-
# string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `
|
440
|
+
# string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
441
441
|
def grant_permission
|
442
442
|
@attributes[:grant_permission]
|
443
443
|
end
|
@@ -521,7 +521,7 @@ module Files
|
|
521
521
|
# change_password - string - Used for changing a password on an existing user.
|
522
522
|
# change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
523
523
|
# email - string - User's email.
|
524
|
-
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `
|
524
|
+
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
525
525
|
# group_id - int64 - Group ID to associate this user with.
|
526
526
|
# group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
527
527
|
# password - string - User password.
|
@@ -663,7 +663,7 @@ module Files
|
|
663
663
|
# change_password - string - Used for changing a password on an existing user.
|
664
664
|
# change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
665
665
|
# email - string - User's email.
|
666
|
-
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `
|
666
|
+
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
667
667
|
# group_id - int64 - Group ID to associate this user with.
|
668
668
|
# group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
669
669
|
# password - string - User password.
|
@@ -765,7 +765,7 @@ module Files
|
|
765
765
|
# change_password - string - Used for changing a password on an existing user.
|
766
766
|
# change_password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
767
767
|
# email - string - User's email.
|
768
|
-
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `
|
768
|
+
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
769
769
|
# group_id - int64 - Group ID to associate this user with.
|
770
770
|
# group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
771
771
|
# password - string - User password.
|
@@ -0,0 +1,127 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class UserRequest
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# string - User's full name
|
13
|
+
def name
|
14
|
+
@attributes[:name]
|
15
|
+
end
|
16
|
+
|
17
|
+
def name=(value)
|
18
|
+
@attributes[:name] = value
|
19
|
+
end
|
20
|
+
|
21
|
+
# email - User email address
|
22
|
+
def email
|
23
|
+
@attributes[:email]
|
24
|
+
end
|
25
|
+
|
26
|
+
def email=(value)
|
27
|
+
@attributes[:email] = value
|
28
|
+
end
|
29
|
+
|
30
|
+
# string - Details of the user's request
|
31
|
+
def details
|
32
|
+
@attributes[:details]
|
33
|
+
end
|
34
|
+
|
35
|
+
def details=(value)
|
36
|
+
@attributes[:details] = value
|
37
|
+
end
|
38
|
+
|
39
|
+
def delete(params = {})
|
40
|
+
params ||= {}
|
41
|
+
params[:id] = @attributes[:id]
|
42
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
43
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
44
|
+
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
45
|
+
|
46
|
+
Api.send_request("/user_requests/#{@attributes[:id]}", :delete, params, @options)
|
47
|
+
end
|
48
|
+
|
49
|
+
def destroy(params = {})
|
50
|
+
delete(params)
|
51
|
+
end
|
52
|
+
|
53
|
+
def save
|
54
|
+
if @attributes[:id]
|
55
|
+
raise NotImplementedError.new("The UserRequest object doesn't support updates.")
|
56
|
+
else
|
57
|
+
new_obj = UserRequest.create(@attributes, @options)
|
58
|
+
@attributes = new_obj.attributes
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
# Parameters:
|
63
|
+
# page - int64 - Current page number.
|
64
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
65
|
+
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
66
|
+
def self.list(params = {}, options = {})
|
67
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
68
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
69
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
|
70
|
+
|
71
|
+
response, options = Api.send_request("/user_requests", :get, params, options)
|
72
|
+
response.data.map do |entity_data|
|
73
|
+
UserRequest.new(entity_data, options)
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
def self.all(params = {}, options = {})
|
78
|
+
list(params, options)
|
79
|
+
end
|
80
|
+
|
81
|
+
# Parameters:
|
82
|
+
# id (required) - int64 - User Request ID.
|
83
|
+
def self.find(id, params = {}, options = {})
|
84
|
+
params ||= {}
|
85
|
+
params[:id] = id
|
86
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
87
|
+
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
88
|
+
|
89
|
+
response, options = Api.send_request("/user_requests/#{params[:id]}", :get, params, options)
|
90
|
+
UserRequest.new(response.data, options)
|
91
|
+
end
|
92
|
+
|
93
|
+
def self.get(id, params = {}, options = {})
|
94
|
+
find(id, params, options)
|
95
|
+
end
|
96
|
+
|
97
|
+
# Parameters:
|
98
|
+
# name (required) - string - Name of user requested
|
99
|
+
# email (required) - string - Email of user requested
|
100
|
+
# details (required) - string - Details of the user request
|
101
|
+
def self.create(params = {}, options = {})
|
102
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
103
|
+
raise InvalidParameterError.new("Bad parameter: email must be an String") if params.dig(:email) and !params.dig(:email).is_a?(String)
|
104
|
+
raise InvalidParameterError.new("Bad parameter: details must be an String") if params.dig(:details) and !params.dig(:details).is_a?(String)
|
105
|
+
raise MissingParameterError.new("Parameter missing: name") unless params.dig(:name)
|
106
|
+
raise MissingParameterError.new("Parameter missing: email") unless params.dig(:email)
|
107
|
+
raise MissingParameterError.new("Parameter missing: details") unless params.dig(:details)
|
108
|
+
|
109
|
+
response, options = Api.send_request("/user_requests", :post, params, options)
|
110
|
+
UserRequest.new(response.data, options)
|
111
|
+
end
|
112
|
+
|
113
|
+
def self.delete(id, params = {}, options = {})
|
114
|
+
params ||= {}
|
115
|
+
params[:id] = id
|
116
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
117
|
+
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
118
|
+
|
119
|
+
response, _options = Api.send_request("/user_requests/#{params[:id]}", :delete, params, options)
|
120
|
+
response.data
|
121
|
+
end
|
122
|
+
|
123
|
+
def self.destroy(id, params = {}, options = {})
|
124
|
+
delete(id, params, options)
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: files.com
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.82
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-07-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|
@@ -134,6 +134,7 @@ files:
|
|
134
134
|
- docs/usage_snapshot.md
|
135
135
|
- docs/user.md
|
136
136
|
- docs/user_cipher_use.md
|
137
|
+
- docs/user_request.md
|
137
138
|
- files.com.gemspec
|
138
139
|
- lib/files.com.rb
|
139
140
|
- lib/files.com/api.rb
|
@@ -191,6 +192,7 @@ files:
|
|
191
192
|
- lib/files.com/models/usage_snapshot.rb
|
192
193
|
- lib/files.com/models/user.rb
|
193
194
|
- lib/files.com/models/user_cipher_use.rb
|
195
|
+
- lib/files.com/models/user_request.rb
|
194
196
|
- lib/files.com/response.rb
|
195
197
|
- lib/files.com/sizable_io.rb
|
196
198
|
- lib/files.com/system_profiler.rb
|