files.com 1.1.200 → 1.1.202
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.
- checksums.yaml +4 -4
- data/README.md +9 -5
- data/_VERSION +1 -1
- data/docs/automation.md +3 -3
- data/docs/behavior.md +9 -9
- data/docs/bundle.md +14 -14
- data/docs/bundle_recipient.md +1 -1
- data/docs/file.md +20 -20
- data/docs/folder.md +4 -4
- data/docs/form_field_set.md +9 -9
- data/docs/group.md +1 -1
- data/docs/group_user.md +3 -3
- data/docs/inbox_recipient.md +1 -1
- data/docs/lock.md +3 -3
- data/docs/notification.md +10 -10
- data/docs/permission.md +2 -2
- data/docs/remote_server.md +3 -3
- data/docs/request.md +2 -2
- data/docs/site.md +84 -84
- data/docs/user.md +16 -16
- data/docs/webhook_test.md +2 -2
- data/lib/files.com/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5dcfb98c0f0bf3917088a4ef6c89c5b216ae3ce1c72e21129037dfa7e00d1284
|
4
|
+
data.tar.gz: f86a3effca89c0931a0537cb0613f26fa842376b89b5df0d26b48e1d7bc54900
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 14a9912dafafa6d398060486c6a10ef227c9304589ab5374f06eeffa7b9f87828c532d707d939f09200461f35128a3a176b09faf017243eb38dcc14e113fd9f5
|
7
|
+
data.tar.gz: 2a72a0f46c1ff673865ec49f46540e0b980598f457cc1c99dc2cba7b45282c56285d9233a2333745427404c2d5453405d76f484afd902ee2c77b8c96a058ac21
|
data/README.md
CHANGED
@@ -51,12 +51,14 @@ To initiate a support conversation, you can send an [Authenticated Support Reque
|
|
51
51
|
|
52
52
|
## Authentication
|
53
53
|
|
54
|
+
There are two ways to authenticate: API Key authentication and Session-based authentication.
|
55
|
+
|
54
56
|
### Authenticate with an API Key
|
55
57
|
|
56
58
|
Authenticating with an API key is the recommended authentication method for most scenarios, and is
|
57
59
|
the method used in the examples on this site.
|
58
60
|
|
59
|
-
To use
|
61
|
+
To use an API Key, first generate an API key from the [web
|
60
62
|
interface](https://www.files.com/docs/sdk-and-apis/api-keys) or [via the API or an
|
61
63
|
SDK](/ruby/resources/developers/api-keys).
|
62
64
|
|
@@ -75,14 +77,14 @@ Don't forget to replace the placeholder, `YOUR_API_KEY`, with your actual API ke
|
|
75
77
|
|
76
78
|
### Authenticate with a Session
|
77
79
|
|
78
|
-
You can also authenticate
|
80
|
+
You can also authenticate by creating a user session using the username and
|
79
81
|
password of an active user. If the user is an administrator, the session will have full access to
|
80
|
-
|
82
|
+
all capabilities of Files.com. Sessions created from regular user accounts will only be able to access files that
|
81
83
|
user can access, and no access will be granted to site administration functions.
|
82
84
|
|
83
|
-
|
85
|
+
Sessions use the exact same session timeout settings as web interface sessions. When a
|
84
86
|
session times out, simply create a new session and resume where you left off. This process is not
|
85
|
-
automatically handled by SDKs because we do not want to store password information in memory without
|
87
|
+
automatically handled by our SDKs because we do not want to store password information in memory without
|
86
88
|
your explicit consent.
|
87
89
|
|
88
90
|
#### Logging In
|
@@ -122,6 +124,8 @@ session.destroy()
|
|
122
124
|
|
123
125
|
## Configuration
|
124
126
|
|
127
|
+
The Ruby SDK is configured by setting attributes on the `Files` object.
|
128
|
+
|
125
129
|
### Configuration Options
|
126
130
|
|
127
131
|
#### Base URL
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.202
|
data/docs/automation.md
CHANGED
@@ -171,7 +171,7 @@ Files::Automation.create(
|
|
171
171
|
import_urls: [{"name":"users.json","url":"http://example.com/users","method":"POST","headers":{"Content-Type":"application/json"},"content":{"group":"support"}}],
|
172
172
|
flatten_destination_structure: true,
|
173
173
|
ignore_locked_folders: true,
|
174
|
-
legacy_folder_matching:
|
174
|
+
legacy_folder_matching: false,
|
175
175
|
name: "example",
|
176
176
|
overwrite_files: true,
|
177
177
|
path_time_zone: "Eastern Time (US & Canada)",
|
@@ -253,7 +253,7 @@ Files::Automation.update(id,
|
|
253
253
|
import_urls: [{"name":"users.json","url":"http://example.com/users","method":"POST","headers":{"Content-Type":"application/json"},"content":{"group":"support"}}],
|
254
254
|
flatten_destination_structure: true,
|
255
255
|
ignore_locked_folders: true,
|
256
|
-
legacy_folder_matching:
|
256
|
+
legacy_folder_matching: false,
|
257
257
|
name: "example",
|
258
258
|
overwrite_files: true,
|
259
259
|
path_time_zone: "Eastern Time (US & Canada)",
|
@@ -353,7 +353,7 @@ automation.update(
|
|
353
353
|
import_urls: [{"name":"users.json","url":"http://example.com/users","method":"POST","headers":{"Content-Type":"application/json"},"content":{"group":"support"}}],
|
354
354
|
flatten_destination_structure: true,
|
355
355
|
ignore_locked_folders: true,
|
356
|
-
legacy_folder_matching:
|
356
|
+
legacy_folder_matching: false,
|
357
357
|
name: "example",
|
358
358
|
overwrite_files: true,
|
359
359
|
path_time_zone: "Eastern Time (US & Canada)",
|
data/docs/behavior.md
CHANGED
@@ -67,7 +67,7 @@ Files::Behavior.find(id)
|
|
67
67
|
|
68
68
|
```
|
69
69
|
Files::Behavior.list_for(path,
|
70
|
-
ancestor_behaviors:
|
70
|
+
ancestor_behaviors: false
|
71
71
|
)
|
72
72
|
```
|
73
73
|
|
@@ -89,8 +89,8 @@ Files::Behavior.list_for(path,
|
|
89
89
|
```
|
90
90
|
Files::Behavior.create(
|
91
91
|
value: "{\"method\": \"GET\"}",
|
92
|
-
disable_parent_folder_behavior:
|
93
|
-
recursive:
|
92
|
+
disable_parent_folder_behavior: false,
|
93
|
+
recursive: false,
|
94
94
|
name: "example",
|
95
95
|
description: "example",
|
96
96
|
path: "path",
|
@@ -141,11 +141,11 @@ Files::Behavior.webhook_test(
|
|
141
141
|
```
|
142
142
|
Files::Behavior.update(id,
|
143
143
|
value: "{\"method\": \"GET\"}",
|
144
|
-
disable_parent_folder_behavior:
|
145
|
-
recursive:
|
144
|
+
disable_parent_folder_behavior: false,
|
145
|
+
recursive: false,
|
146
146
|
name: "example",
|
147
147
|
description: "example",
|
148
|
-
attachment_delete:
|
148
|
+
attachment_delete: false
|
149
149
|
)
|
150
150
|
```
|
151
151
|
|
@@ -183,11 +183,11 @@ behavior = Files::Behavior.find(id)
|
|
183
183
|
|
184
184
|
behavior.update(
|
185
185
|
value: "{\"method\": \"GET\"}",
|
186
|
-
disable_parent_folder_behavior:
|
187
|
-
recursive:
|
186
|
+
disable_parent_folder_behavior: false,
|
187
|
+
recursive: false,
|
188
188
|
name: "example",
|
189
189
|
description: "example",
|
190
|
-
attachment_delete:
|
190
|
+
attachment_delete: false
|
191
191
|
)
|
192
192
|
```
|
193
193
|
|
data/docs/bundle.md
CHANGED
@@ -176,10 +176,10 @@ Files::Bundle.create(
|
|
176
176
|
paths: ["file.txt"],
|
177
177
|
password: "Password",
|
178
178
|
form_field_set_id: 1,
|
179
|
-
create_snapshot:
|
179
|
+
create_snapshot: false,
|
180
180
|
dont_separate_submissions_by_folder: true,
|
181
181
|
expires_at: "2000-01-01T01:00:00Z",
|
182
|
-
finalize_snapshot:
|
182
|
+
finalize_snapshot: false,
|
183
183
|
max_uses: 1,
|
184
184
|
description: "The public description of the bundle.",
|
185
185
|
note: "The internal note on the bundle.",
|
@@ -187,10 +187,10 @@ Files::Bundle.create(
|
|
187
187
|
path_template: "{{name}}_{{ip}}",
|
188
188
|
path_template_time_zone: "Eastern Time (US & Canada)",
|
189
189
|
permissions: "read",
|
190
|
-
require_registration:
|
190
|
+
require_registration: false,
|
191
191
|
clickwrap_id: 1,
|
192
192
|
inbox_id: 1,
|
193
|
-
require_share_recipient:
|
193
|
+
require_share_recipient: false,
|
194
194
|
send_email_receipt_to_uploader: true,
|
195
195
|
skip_email: true,
|
196
196
|
skip_name: true,
|
@@ -261,25 +261,25 @@ Files::Bundle.update(id,
|
|
261
261
|
form_field_set_id: 1,
|
262
262
|
clickwrap_id: 1,
|
263
263
|
code: "abc123",
|
264
|
-
create_snapshot:
|
264
|
+
create_snapshot: false,
|
265
265
|
description: "The public description of the bundle.",
|
266
266
|
dont_separate_submissions_by_folder: true,
|
267
267
|
expires_at: "2000-01-01T01:00:00Z",
|
268
|
-
finalize_snapshot:
|
268
|
+
finalize_snapshot: false,
|
269
269
|
inbox_id: 1,
|
270
270
|
max_uses: 1,
|
271
271
|
note: "The internal note on the bundle.",
|
272
272
|
path_template: "{{name}}_{{ip}}",
|
273
273
|
path_template_time_zone: "Eastern Time (US & Canada)",
|
274
274
|
permissions: "read",
|
275
|
-
require_registration:
|
276
|
-
require_share_recipient:
|
275
|
+
require_registration: false,
|
276
|
+
require_share_recipient: false,
|
277
277
|
send_email_receipt_to_uploader: true,
|
278
278
|
skip_company: true,
|
279
279
|
start_access_on_date: "2000-01-01T01:00:00Z",
|
280
280
|
skip_email: true,
|
281
281
|
skip_name: true,
|
282
|
-
watermark_attachment_delete:
|
282
|
+
watermark_attachment_delete: false
|
283
283
|
)
|
284
284
|
```
|
285
285
|
|
@@ -361,25 +361,25 @@ bundle.update(
|
|
361
361
|
form_field_set_id: 1,
|
362
362
|
clickwrap_id: 1,
|
363
363
|
code: "abc123",
|
364
|
-
create_snapshot:
|
364
|
+
create_snapshot: false,
|
365
365
|
description: "The public description of the bundle.",
|
366
366
|
dont_separate_submissions_by_folder: true,
|
367
367
|
expires_at: "2000-01-01T01:00:00Z",
|
368
|
-
finalize_snapshot:
|
368
|
+
finalize_snapshot: false,
|
369
369
|
inbox_id: 1,
|
370
370
|
max_uses: 1,
|
371
371
|
note: "The internal note on the bundle.",
|
372
372
|
path_template: "{{name}}_{{ip}}",
|
373
373
|
path_template_time_zone: "Eastern Time (US & Canada)",
|
374
374
|
permissions: "read",
|
375
|
-
require_registration:
|
376
|
-
require_share_recipient:
|
375
|
+
require_registration: false,
|
376
|
+
require_share_recipient: false,
|
377
377
|
send_email_receipt_to_uploader: true,
|
378
378
|
skip_company: true,
|
379
379
|
start_access_on_date: "2000-01-01T01:00:00Z",
|
380
380
|
skip_email: true,
|
381
381
|
skip_name: true,
|
382
|
-
watermark_attachment_delete:
|
382
|
+
watermark_attachment_delete: false
|
383
383
|
)
|
384
384
|
```
|
385
385
|
|
data/docs/bundle_recipient.md
CHANGED
data/docs/file.md
CHANGED
@@ -105,8 +105,8 @@ may places where a Ruby File object can be used.
|
|
105
105
|
|
106
106
|
```
|
107
107
|
Files::File.download(path,
|
108
|
-
with_previews:
|
109
|
-
with_priority_color:
|
108
|
+
with_previews: false,
|
109
|
+
with_priority_color: false
|
110
110
|
)
|
111
111
|
```
|
112
112
|
|
@@ -126,13 +126,13 @@ Files::File.download(path,
|
|
126
126
|
```
|
127
127
|
Files::File.create(path,
|
128
128
|
length: 1,
|
129
|
-
mkdir_parents:
|
129
|
+
mkdir_parents: false,
|
130
130
|
part: 1,
|
131
131
|
parts: 1,
|
132
132
|
provided_mtime: "2000-01-01T01:00:00Z",
|
133
133
|
restart: 1,
|
134
134
|
size: 1,
|
135
|
-
with_rename:
|
135
|
+
with_rename: false
|
136
136
|
)
|
137
137
|
```
|
138
138
|
|
@@ -180,7 +180,7 @@ Files::File.update(path,
|
|
180
180
|
|
181
181
|
```
|
182
182
|
Files::File.delete(path,
|
183
|
-
recursive:
|
183
|
+
recursive: false
|
184
184
|
)
|
185
185
|
```
|
186
186
|
|
@@ -196,8 +196,8 @@ Files::File.delete(path,
|
|
196
196
|
|
197
197
|
```
|
198
198
|
Files::File.find(path,
|
199
|
-
with_previews:
|
200
|
-
with_priority_color:
|
199
|
+
with_previews: false,
|
200
|
+
with_priority_color: false
|
201
201
|
)
|
202
202
|
```
|
203
203
|
|
@@ -216,8 +216,8 @@ Files::File.find(path,
|
|
216
216
|
```
|
217
217
|
Files::File.copy(path,
|
218
218
|
destination: "destination",
|
219
|
-
structure:
|
220
|
-
overwrite:
|
219
|
+
structure: false,
|
220
|
+
overwrite: false
|
221
221
|
)
|
222
222
|
```
|
223
223
|
|
@@ -236,7 +236,7 @@ Files::File.copy(path,
|
|
236
236
|
```
|
237
237
|
Files::File.move(path,
|
238
238
|
destination: "destination",
|
239
|
-
overwrite:
|
239
|
+
overwrite: false
|
240
240
|
)
|
241
241
|
```
|
242
242
|
|
@@ -253,13 +253,13 @@ Files::File.move(path,
|
|
253
253
|
|
254
254
|
```
|
255
255
|
Files::File.begin_upload(path,
|
256
|
-
mkdir_parents:
|
256
|
+
mkdir_parents: false,
|
257
257
|
part: 1,
|
258
258
|
parts: 1,
|
259
259
|
ref: "upload-1",
|
260
260
|
restart: 1,
|
261
261
|
size: 1,
|
262
|
-
with_rename:
|
262
|
+
with_rename: false
|
263
263
|
)
|
264
264
|
```
|
265
265
|
|
@@ -283,8 +283,8 @@ Files::File.begin_upload(path,
|
|
283
283
|
file = Files::File.find(path)
|
284
284
|
|
285
285
|
file.download(
|
286
|
-
with_previews:
|
287
|
-
with_priority_color:
|
286
|
+
with_previews: false,
|
287
|
+
with_priority_color: false
|
288
288
|
)
|
289
289
|
```
|
290
290
|
|
@@ -327,7 +327,7 @@ file.update(
|
|
327
327
|
file = Files::File.find(path)
|
328
328
|
|
329
329
|
file.delete(
|
330
|
-
recursive:
|
330
|
+
recursive: false
|
331
331
|
)
|
332
332
|
```
|
333
333
|
|
@@ -346,8 +346,8 @@ file = Files::File.find(path)
|
|
346
346
|
|
347
347
|
file.copy(
|
348
348
|
destination: "destination",
|
349
|
-
structure:
|
350
|
-
overwrite:
|
349
|
+
structure: false,
|
350
|
+
overwrite: false
|
351
351
|
)
|
352
352
|
```
|
353
353
|
|
@@ -368,7 +368,7 @@ file = Files::File.find(path)
|
|
368
368
|
|
369
369
|
file.move(
|
370
370
|
destination: "destination",
|
371
|
-
overwrite:
|
371
|
+
overwrite: false
|
372
372
|
)
|
373
373
|
```
|
374
374
|
|
@@ -387,13 +387,13 @@ file.move(
|
|
387
387
|
file = Files::File.find(path)
|
388
388
|
|
389
389
|
file.begin_upload(
|
390
|
-
mkdir_parents:
|
390
|
+
mkdir_parents: false,
|
391
391
|
part: 1,
|
392
392
|
parts: 1,
|
393
393
|
ref: "upload-1",
|
394
394
|
restart: 1,
|
395
395
|
size: 1,
|
396
|
-
with_rename:
|
396
|
+
with_rename: false
|
397
397
|
)
|
398
398
|
```
|
399
399
|
|
data/docs/folder.md
CHANGED
@@ -100,9 +100,9 @@ Files::Dir is an alias of Files::Folder
|
|
100
100
|
```
|
101
101
|
Files::Folder.list_for(path,
|
102
102
|
search: "some-partial-filename",
|
103
|
-
search_all:
|
104
|
-
with_previews:
|
105
|
-
with_priority_color:
|
103
|
+
search_all: false,
|
104
|
+
with_previews: false,
|
105
|
+
with_priority_color: false
|
106
106
|
)
|
107
107
|
```
|
108
108
|
|
@@ -125,7 +125,7 @@ Files::Folder.list_for(path,
|
|
125
125
|
|
126
126
|
```
|
127
127
|
Files::Folder.create(path,
|
128
|
-
mkdir_parents:
|
128
|
+
mkdir_parents: false,
|
129
129
|
provided_mtime: "2000-01-01T01:00:00Z"
|
130
130
|
)
|
131
131
|
```
|
data/docs/form_field_set.md
CHANGED
@@ -82,9 +82,9 @@ Files::FormFieldSet.find(id)
|
|
82
82
|
Files::FormFieldSet.create(
|
83
83
|
user_id: 1,
|
84
84
|
title: "Sample Form Title",
|
85
|
-
skip_email:
|
86
|
-
skip_name:
|
87
|
-
skip_company:
|
85
|
+
skip_email: false,
|
86
|
+
skip_name: false,
|
87
|
+
skip_company: false,
|
88
88
|
form_fields: [{"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
|
89
89
|
)
|
90
90
|
```
|
@@ -106,9 +106,9 @@ Files::FormFieldSet.create(
|
|
106
106
|
```
|
107
107
|
Files::FormFieldSet.update(id,
|
108
108
|
title: "Sample Form Title",
|
109
|
-
skip_email:
|
110
|
-
skip_name:
|
111
|
-
skip_company:
|
109
|
+
skip_email: false,
|
110
|
+
skip_name: false,
|
111
|
+
skip_company: false,
|
112
112
|
form_fields: [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
|
113
113
|
)
|
114
114
|
```
|
@@ -145,9 +145,9 @@ form_field_set = Files::FormFieldSet.find(id)
|
|
145
145
|
|
146
146
|
form_field_set.update(
|
147
147
|
title: "Sample Form Title",
|
148
|
-
skip_email:
|
149
|
-
skip_name:
|
150
|
-
skip_company:
|
148
|
+
skip_email: false,
|
149
|
+
skip_name: false,
|
150
|
+
skip_company: false,
|
151
151
|
form_fields: [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
|
152
152
|
)
|
153
153
|
```
|
data/docs/group.md
CHANGED
data/docs/group_user.md
CHANGED
@@ -47,7 +47,7 @@ Files::GroupUser.list(
|
|
47
47
|
Files::GroupUser.create(
|
48
48
|
group_id: 1,
|
49
49
|
user_id: 1,
|
50
|
-
admin:
|
50
|
+
admin: false
|
51
51
|
)
|
52
52
|
```
|
53
53
|
|
@@ -66,7 +66,7 @@ Files::GroupUser.create(
|
|
66
66
|
Files::GroupUser.update(id,
|
67
67
|
group_id: 1,
|
68
68
|
user_id: 1,
|
69
|
-
admin:
|
69
|
+
admin: false
|
70
70
|
)
|
71
71
|
```
|
72
72
|
|
@@ -106,7 +106,7 @@ group_user = Files::GroupUser.list.first
|
|
106
106
|
group_user.update(
|
107
107
|
group_id: 1,
|
108
108
|
user_id: 1,
|
109
|
-
admin:
|
109
|
+
admin: false
|
110
110
|
)
|
111
111
|
```
|
112
112
|
|
data/docs/inbox_recipient.md
CHANGED
data/docs/lock.md
CHANGED
@@ -39,7 +39,7 @@
|
|
39
39
|
|
40
40
|
```
|
41
41
|
Files::Lock.list_for(path,
|
42
|
-
include_children:
|
42
|
+
include_children: false
|
43
43
|
)
|
44
44
|
```
|
45
45
|
|
@@ -57,8 +57,8 @@ Files::Lock.list_for(path,
|
|
57
57
|
|
58
58
|
```
|
59
59
|
Files::Lock.create(path,
|
60
|
-
allow_access_by_any_user:
|
61
|
-
exclusive:
|
60
|
+
allow_access_by_any_user: false,
|
61
|
+
exclusive: false,
|
62
62
|
recursive: true,
|
63
63
|
timeout: 1
|
64
64
|
)
|
data/docs/notification.md
CHANGED
@@ -66,7 +66,7 @@
|
|
66
66
|
|
67
67
|
```
|
68
68
|
Files::Notification.list(
|
69
|
-
include_ancestors:
|
69
|
+
include_ancestors: false,
|
70
70
|
group_id: 1
|
71
71
|
)
|
72
72
|
```
|
@@ -103,13 +103,13 @@ Files::Notification.find(id)
|
|
103
103
|
```
|
104
104
|
Files::Notification.create(
|
105
105
|
user_id: 1,
|
106
|
-
notify_on_copy:
|
106
|
+
notify_on_copy: false,
|
107
107
|
notify_on_delete: true,
|
108
108
|
notify_on_download: true,
|
109
109
|
notify_on_move: true,
|
110
110
|
notify_on_upload: true,
|
111
|
-
notify_user_actions:
|
112
|
-
recursive:
|
111
|
+
notify_user_actions: false,
|
112
|
+
recursive: false,
|
113
113
|
send_interval: "daily",
|
114
114
|
message: "custom notification email message",
|
115
115
|
triggering_filenames: ["*.jpg","notify_file.txt"],
|
@@ -148,13 +148,13 @@ Files::Notification.create(
|
|
148
148
|
|
149
149
|
```
|
150
150
|
Files::Notification.update(id,
|
151
|
-
notify_on_copy:
|
151
|
+
notify_on_copy: false,
|
152
152
|
notify_on_delete: true,
|
153
153
|
notify_on_download: true,
|
154
154
|
notify_on_move: true,
|
155
155
|
notify_on_upload: true,
|
156
|
-
notify_user_actions:
|
157
|
-
recursive:
|
156
|
+
notify_user_actions: false,
|
157
|
+
recursive: false,
|
158
158
|
send_interval: "daily",
|
159
159
|
message: "custom notification email message",
|
160
160
|
triggering_filenames: ["*.jpg","notify_file.txt"],
|
@@ -203,13 +203,13 @@ Files::Notification.delete(id)
|
|
203
203
|
notification = Files::Notification.find(id)
|
204
204
|
|
205
205
|
notification.update(
|
206
|
-
notify_on_copy:
|
206
|
+
notify_on_copy: false,
|
207
207
|
notify_on_delete: true,
|
208
208
|
notify_on_download: true,
|
209
209
|
notify_on_move: true,
|
210
210
|
notify_on_upload: true,
|
211
|
-
notify_user_actions:
|
212
|
-
recursive:
|
211
|
+
notify_user_actions: false,
|
212
|
+
recursive: false,
|
213
213
|
send_interval: "daily",
|
214
214
|
message: "custom notification email message",
|
215
215
|
triggering_filenames: ["*.jpg","notify_file.txt"],
|
data/docs/permission.md
CHANGED
@@ -32,7 +32,7 @@
|
|
32
32
|
```
|
33
33
|
Files::Permission.list(
|
34
34
|
path: "example",
|
35
|
-
include_groups:
|
35
|
+
include_groups: false,
|
36
36
|
group_id: 1,
|
37
37
|
user_id: 1
|
38
38
|
)
|
@@ -60,7 +60,7 @@ Files::Permission.create(
|
|
60
60
|
path: "path",
|
61
61
|
group_id: 1,
|
62
62
|
permission: "full",
|
63
|
-
recursive:
|
63
|
+
recursive: false,
|
64
64
|
user_id: 1,
|
65
65
|
username: "user",
|
66
66
|
group_name: "example"
|
data/docs/remote_server.md
CHANGED
@@ -191,7 +191,7 @@ Files::RemoteServer.find_configuration_file(id)
|
|
191
191
|
Files::RemoteServer.create(
|
192
192
|
aws_access_key: "example",
|
193
193
|
wasabi_access_key: "example",
|
194
|
-
reset_authentication:
|
194
|
+
reset_authentication: false,
|
195
195
|
hostname: "remote-server.com",
|
196
196
|
name: "My Remote server",
|
197
197
|
max_connections: 1,
|
@@ -352,7 +352,7 @@ Files::RemoteServer.configuration_file(id,
|
|
352
352
|
Files::RemoteServer.update(id,
|
353
353
|
aws_access_key: "example",
|
354
354
|
wasabi_access_key: "example",
|
355
|
-
reset_authentication:
|
355
|
+
reset_authentication: false,
|
356
356
|
hostname: "remote-server.com",
|
357
357
|
name: "My Remote server",
|
358
358
|
max_connections: 1,
|
@@ -531,7 +531,7 @@ remote_server = Files::RemoteServer.find(id)
|
|
531
531
|
remote_server.update(
|
532
532
|
aws_access_key: "example",
|
533
533
|
wasabi_access_key: "example",
|
534
|
-
reset_authentication:
|
534
|
+
reset_authentication: false,
|
535
535
|
hostname: "remote-server.com",
|
536
536
|
name: "My Remote server",
|
537
537
|
max_connections: 1,
|
data/docs/request.md
CHANGED
data/docs/site.md
CHANGED
@@ -499,55 +499,55 @@ Files::Site.update(
|
|
499
499
|
name: "My Site",
|
500
500
|
subdomain: "mysite",
|
501
501
|
domain: "my-custom-domain.com",
|
502
|
-
domain_hsts_header:
|
502
|
+
domain_hsts_header: false,
|
503
503
|
domain_letsencrypt_chain: "example",
|
504
504
|
email: "example",
|
505
505
|
reply_to_email: "example",
|
506
|
-
allow_bundle_names:
|
506
|
+
allow_bundle_names: false,
|
507
507
|
bundle_expiration: 1,
|
508
|
-
welcome_email_enabled:
|
509
|
-
ask_about_overwrites:
|
510
|
-
show_request_access_link:
|
511
|
-
always_mkdir_parents:
|
508
|
+
welcome_email_enabled: false,
|
509
|
+
ask_about_overwrites: false,
|
510
|
+
show_request_access_link: false,
|
511
|
+
always_mkdir_parents: false,
|
512
512
|
welcome_email_cc: "example",
|
513
513
|
welcome_email_subject: "example",
|
514
514
|
welcome_custom_text: "Welcome to my site!",
|
515
515
|
language: "en",
|
516
|
-
windows_mode_ftp:
|
516
|
+
windows_mode_ftp: false,
|
517
517
|
default_time_zone: "Pacific Time (US & Canada)",
|
518
|
-
desktop_app:
|
519
|
-
desktop_app_session_ip_pinning:
|
518
|
+
desktop_app: false,
|
519
|
+
desktop_app_session_ip_pinning: false,
|
520
520
|
desktop_app_session_lifetime: 1,
|
521
|
-
mobile_app:
|
522
|
-
mobile_app_session_ip_pinning:
|
521
|
+
mobile_app: false,
|
522
|
+
mobile_app_session_ip_pinning: false,
|
523
523
|
mobile_app_session_lifetime: 1,
|
524
|
-
folder_permissions_groups_only:
|
524
|
+
folder_permissions_groups_only: false,
|
525
525
|
welcome_screen: "user_controlled",
|
526
|
-
office_integration_available:
|
526
|
+
office_integration_available: false,
|
527
527
|
office_integration_type: "example",
|
528
|
-
pin_all_remote_servers_to_site_region:
|
528
|
+
pin_all_remote_servers_to_site_region: false,
|
529
529
|
motd_text: "example",
|
530
|
-
motd_use_for_ftp:
|
531
|
-
motd_use_for_sftp:
|
530
|
+
motd_use_for_ftp: false,
|
531
|
+
motd_use_for_sftp: false,
|
532
532
|
additional_text_file_types: ["example"],
|
533
|
-
bundle_require_note:
|
534
|
-
bundle_send_shared_receipts:
|
535
|
-
calculate_file_checksums_crc32:
|
536
|
-
calculate_file_checksums_md5:
|
537
|
-
calculate_file_checksums_sha1:
|
538
|
-
calculate_file_checksums_sha256:
|
539
|
-
legacy_checksums_mode:
|
533
|
+
bundle_require_note: false,
|
534
|
+
bundle_send_shared_receipts: false,
|
535
|
+
calculate_file_checksums_crc32: false,
|
536
|
+
calculate_file_checksums_md5: false,
|
537
|
+
calculate_file_checksums_sha1: false,
|
538
|
+
calculate_file_checksums_sha256: false,
|
539
|
+
legacy_checksums_mode: false,
|
540
540
|
session_expiry: 1.0,
|
541
|
-
ssl_required:
|
542
|
-
tls_disabled:
|
543
|
-
sftp_insecure_ciphers:
|
544
|
-
sftp_insecure_diffie_hellman:
|
545
|
-
disable_files_certificate_generation:
|
546
|
-
user_lockout:
|
541
|
+
ssl_required: false,
|
542
|
+
tls_disabled: false,
|
543
|
+
sftp_insecure_ciphers: false,
|
544
|
+
sftp_insecure_diffie_hellman: false,
|
545
|
+
disable_files_certificate_generation: false,
|
546
|
+
user_lockout: false,
|
547
547
|
user_lockout_tries: 1,
|
548
548
|
user_lockout_within: 1,
|
549
549
|
user_lockout_lock_period: 1,
|
550
|
-
include_password_in_welcome_email:
|
550
|
+
include_password_in_welcome_email: false,
|
551
551
|
allowed_countries: "US,DE",
|
552
552
|
allowed_ips: "example",
|
553
553
|
disallowed_countries: "US,DE",
|
@@ -556,57 +556,57 @@ Files::Site.update(
|
|
556
556
|
max_prior_passwords: 1,
|
557
557
|
password_validity_days: 1,
|
558
558
|
password_min_length: 1,
|
559
|
-
password_require_letter:
|
560
|
-
password_require_mixed:
|
561
|
-
password_require_special:
|
562
|
-
password_require_number:
|
563
|
-
password_require_unbreached:
|
564
|
-
require_logout_from_bundles_and_inboxes:
|
565
|
-
dav_user_root_enabled:
|
566
|
-
sftp_user_root_enabled:
|
567
|
-
disable_password_reset:
|
568
|
-
immutable_files:
|
559
|
+
password_require_letter: false,
|
560
|
+
password_require_mixed: false,
|
561
|
+
password_require_special: false,
|
562
|
+
password_require_number: false,
|
563
|
+
password_require_unbreached: false,
|
564
|
+
require_logout_from_bundles_and_inboxes: false,
|
565
|
+
dav_user_root_enabled: false,
|
566
|
+
sftp_user_root_enabled: false,
|
567
|
+
disable_password_reset: false,
|
568
|
+
immutable_files: false,
|
569
569
|
bundle_not_found_message: "example",
|
570
|
-
bundle_password_required:
|
571
|
-
bundle_require_registration:
|
572
|
-
bundle_require_share_recipient:
|
570
|
+
bundle_password_required: false,
|
571
|
+
bundle_require_registration: false,
|
572
|
+
bundle_require_share_recipient: false,
|
573
573
|
bundle_registration_notifications: "never",
|
574
574
|
bundle_activity_notifications: "never",
|
575
575
|
bundle_upload_receipt_notifications: "never",
|
576
|
-
document_edits_in_bundle_allowed:
|
577
|
-
password_requirements_apply_to_bundles:
|
578
|
-
prevent_root_permissions_for_non_site_admins:
|
579
|
-
opt_out_global:
|
580
|
-
use_provided_modified_at:
|
581
|
-
custom_namespace:
|
576
|
+
document_edits_in_bundle_allowed: false,
|
577
|
+
password_requirements_apply_to_bundles: false,
|
578
|
+
prevent_root_permissions_for_non_site_admins: false,
|
579
|
+
opt_out_global: false,
|
580
|
+
use_provided_modified_at: false,
|
581
|
+
custom_namespace: false,
|
582
582
|
disable_users_from_inactivity_period_days: 1,
|
583
|
-
non_sso_groups_allowed:
|
584
|
-
non_sso_users_allowed:
|
585
|
-
sharing_enabled:
|
586
|
-
user_requests_enabled:
|
587
|
-
user_requests_notify_admins:
|
588
|
-
dav_enabled:
|
589
|
-
ftp_enabled:
|
590
|
-
sftp_enabled:
|
591
|
-
users_can_create_api_keys:
|
592
|
-
users_can_create_ssh_keys:
|
593
|
-
show_user_notifications_log_in_link:
|
583
|
+
non_sso_groups_allowed: false,
|
584
|
+
non_sso_users_allowed: false,
|
585
|
+
sharing_enabled: false,
|
586
|
+
user_requests_enabled: false,
|
587
|
+
user_requests_notify_admins: false,
|
588
|
+
dav_enabled: false,
|
589
|
+
ftp_enabled: false,
|
590
|
+
sftp_enabled: false,
|
591
|
+
users_can_create_api_keys: false,
|
592
|
+
users_can_create_ssh_keys: false,
|
593
|
+
show_user_notifications_log_in_link: false,
|
594
594
|
sftp_host_key_type: "default",
|
595
595
|
active_sftp_host_key_id: 1,
|
596
|
-
protocol_access_groups_only:
|
596
|
+
protocol_access_groups_only: false,
|
597
597
|
bundle_watermark_value: {"key":"example value"},
|
598
|
-
group_admins_can_set_user_password:
|
599
|
-
bundle_recipient_blacklist_free_email_domains:
|
598
|
+
group_admins_can_set_user_password: false,
|
599
|
+
bundle_recipient_blacklist_free_email_domains: false,
|
600
600
|
bundle_recipient_blacklist_domains: ["example"],
|
601
|
-
admins_bypass_locked_subfolders:
|
602
|
-
allowed_2fa_method_sms:
|
603
|
-
allowed_2fa_method_totp:
|
604
|
-
allowed_2fa_method_webauthn:
|
605
|
-
allowed_2fa_method_yubi:
|
606
|
-
allowed_2fa_method_email:
|
607
|
-
allowed_2fa_method_static:
|
608
|
-
allowed_2fa_method_bypass_for_ftp_sftp_dav:
|
609
|
-
require_2fa:
|
601
|
+
admins_bypass_locked_subfolders: false,
|
602
|
+
allowed_2fa_method_sms: false,
|
603
|
+
allowed_2fa_method_totp: false,
|
604
|
+
allowed_2fa_method_webauthn: false,
|
605
|
+
allowed_2fa_method_yubi: false,
|
606
|
+
allowed_2fa_method_email: false,
|
607
|
+
allowed_2fa_method_static: false,
|
608
|
+
allowed_2fa_method_bypass_for_ftp_sftp_dav: false,
|
609
|
+
require_2fa: false,
|
610
610
|
require_2fa_user_type: "`site_admins`",
|
611
611
|
color2_top: "#000000",
|
612
612
|
color2_left: "#0066a7",
|
@@ -616,19 +616,19 @@ Files::Site.update(
|
|
616
616
|
site_header: "example",
|
617
617
|
site_footer: "example",
|
618
618
|
login_help_text: "Login page help text.",
|
619
|
-
use_dedicated_ips_for_smtp:
|
619
|
+
use_dedicated_ips_for_smtp: false,
|
620
620
|
smtp_address: "smtp.my-mail-server.com",
|
621
621
|
smtp_authentication: "plain",
|
622
622
|
smtp_from: "me@my-mail-server.com",
|
623
623
|
smtp_username: "mail",
|
624
624
|
smtp_port: 1,
|
625
|
-
ldap_enabled:
|
625
|
+
ldap_enabled: false,
|
626
626
|
ldap_type: "open_ldap",
|
627
627
|
ldap_host: "ldap.site.com",
|
628
628
|
ldap_host_2: "ldap2.site.com",
|
629
629
|
ldap_host_3: "ldap3.site.com",
|
630
630
|
ldap_port: 1,
|
631
|
-
ldap_secure:
|
631
|
+
ldap_secure: false,
|
632
632
|
ldap_username: "[ldap username]",
|
633
633
|
ldap_username_field: "sAMAccountName",
|
634
634
|
ldap_domain: "mysite.com",
|
@@ -638,15 +638,15 @@ Files::Site.update(
|
|
638
638
|
ldap_group_exclusion: "example",
|
639
639
|
ldap_group_inclusion: "example",
|
640
640
|
ldap_base_dn: "example",
|
641
|
-
uploads_via_email_authentication:
|
642
|
-
icon16_delete:
|
643
|
-
icon32_delete:
|
644
|
-
icon48_delete:
|
645
|
-
icon128_delete:
|
646
|
-
logo_delete:
|
647
|
-
bundle_watermark_attachment_delete:
|
648
|
-
login_page_background_image_delete:
|
649
|
-
disable_2fa_with_delay:
|
641
|
+
uploads_via_email_authentication: false,
|
642
|
+
icon16_delete: false,
|
643
|
+
icon32_delete: false,
|
644
|
+
icon48_delete: false,
|
645
|
+
icon128_delete: false,
|
646
|
+
logo_delete: false,
|
647
|
+
bundle_watermark_attachment_delete: false,
|
648
|
+
login_page_background_image_delete: false,
|
649
|
+
disable_2fa_with_delay: false,
|
650
650
|
session_expiry_minutes: 1
|
651
651
|
)
|
652
652
|
```
|
data/docs/user.md
CHANGED
@@ -159,7 +159,7 @@
|
|
159
159
|
|
160
160
|
```
|
161
161
|
Files::User.list(
|
162
|
-
include_parent_site_users:
|
162
|
+
include_parent_site_users: false
|
163
163
|
)
|
164
164
|
```
|
165
165
|
|
@@ -198,18 +198,18 @@ Files::User.find(id)
|
|
198
198
|
|
199
199
|
```
|
200
200
|
Files::User.create(
|
201
|
-
avatar_delete:
|
201
|
+
avatar_delete: false,
|
202
202
|
email: "example",
|
203
203
|
group_id: 1,
|
204
204
|
group_ids: "example",
|
205
|
-
announcements_read:
|
205
|
+
announcements_read: false,
|
206
206
|
allowed_ips: "10.0.0.0/8\n127.0.0.1",
|
207
207
|
attachments_permission: true,
|
208
208
|
authenticate_until: "2000-01-01T01:00:00Z",
|
209
209
|
authentication_method: "password",
|
210
|
-
billing_permission:
|
211
|
-
bypass_inactive_disable:
|
212
|
-
bypass_site_allowed_ips:
|
210
|
+
billing_permission: false,
|
211
|
+
bypass_inactive_disable: false,
|
212
|
+
bypass_site_allowed_ips: false,
|
213
213
|
dav_permission: true,
|
214
214
|
disabled: true,
|
215
215
|
ftp_permission: true,
|
@@ -337,18 +337,18 @@ Files::User.user_2fa_reset(id)
|
|
337
337
|
|
338
338
|
```
|
339
339
|
Files::User.update(id,
|
340
|
-
avatar_delete:
|
340
|
+
avatar_delete: false,
|
341
341
|
email: "example",
|
342
342
|
group_id: 1,
|
343
343
|
group_ids: "example",
|
344
|
-
announcements_read:
|
344
|
+
announcements_read: false,
|
345
345
|
allowed_ips: "10.0.0.0/8\n127.0.0.1",
|
346
346
|
attachments_permission: true,
|
347
347
|
authenticate_until: "2000-01-01T01:00:00Z",
|
348
348
|
authentication_method: "password",
|
349
|
-
billing_permission:
|
350
|
-
bypass_inactive_disable:
|
351
|
-
bypass_site_allowed_ips:
|
349
|
+
billing_permission: false,
|
350
|
+
bypass_inactive_disable: false,
|
351
|
+
bypass_site_allowed_ips: false,
|
352
352
|
dav_permission: true,
|
353
353
|
disabled: true,
|
354
354
|
ftp_permission: true,
|
@@ -498,18 +498,18 @@ user.user_2fa_reset
|
|
498
498
|
user = Files::User.find(id)
|
499
499
|
|
500
500
|
user.update(
|
501
|
-
avatar_delete:
|
501
|
+
avatar_delete: false,
|
502
502
|
email: "example",
|
503
503
|
group_id: 1,
|
504
504
|
group_ids: "example",
|
505
|
-
announcements_read:
|
505
|
+
announcements_read: false,
|
506
506
|
allowed_ips: "10.0.0.0/8\n127.0.0.1",
|
507
507
|
attachments_permission: true,
|
508
508
|
authenticate_until: "2000-01-01T01:00:00Z",
|
509
509
|
authentication_method: "password",
|
510
|
-
billing_permission:
|
511
|
-
bypass_inactive_disable:
|
512
|
-
bypass_site_allowed_ips:
|
510
|
+
billing_permission: false,
|
511
|
+
bypass_inactive_disable: false,
|
512
|
+
bypass_site_allowed_ips: false,
|
513
513
|
dav_permission: true,
|
514
514
|
disabled: true,
|
515
515
|
ftp_permission: true,
|
data/docs/webhook_test.md
CHANGED
@@ -41,9 +41,9 @@ Files::WebhookTest.create(
|
|
41
41
|
headers: {"x-test-header":"testvalue"},
|
42
42
|
body: {"test-param":"testvalue"},
|
43
43
|
raw_body: "test body",
|
44
|
-
file_as_body:
|
44
|
+
file_as_body: false,
|
45
45
|
file_form_field: "upload_file_data",
|
46
|
-
use_dedicated_ips:
|
46
|
+
use_dedicated_ips: false
|
47
47
|
)
|
48
48
|
```
|
49
49
|
|
data/lib/files.com/version.rb
CHANGED