files.com 1.0.295 → 1.0.297

Sign up to get free protection for your applications and to get access to all the features.
Files changed (52) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/account_line_item.md +3 -19
  4. data/docs/action_notification_export.md +1 -1
  5. data/docs/api_key.md +4 -1
  6. data/docs/app.md +17 -15
  7. data/docs/as2_incoming_message.md +29 -25
  8. data/docs/as2_outgoing_message.md +24 -20
  9. data/docs/as2_partner.md +9 -7
  10. data/docs/as2_station.md +9 -9
  11. data/docs/automation.md +28 -24
  12. data/docs/behavior.md +15 -7
  13. data/docs/bundle.md +4 -33
  14. data/docs/bundle_download.md +2 -2
  15. data/docs/bundle_registration.md +5 -3
  16. data/docs/clickwrap.md +15 -6
  17. data/docs/dns_record.md +1 -1
  18. data/docs/external_event.md +7 -7
  19. data/docs/file.md +1 -7
  20. data/docs/file_action.md +1 -1
  21. data/docs/file_comment.md +1 -4
  22. data/docs/file_upload_part.md +11 -5
  23. data/docs/folder.md +1 -7
  24. data/docs/form_field_set.md +4 -17
  25. data/docs/group.md +5 -2
  26. data/docs/group_user.md +1 -1
  27. data/docs/history_export.md +1 -1
  28. data/docs/inbox_registration.md +5 -3
  29. data/docs/inbox_upload.md +2 -2
  30. data/docs/invoice.md +3 -19
  31. data/docs/lock.md +1 -1
  32. data/docs/message.md +1 -10
  33. data/docs/message_comment.md +1 -4
  34. data/docs/notification.md +2 -2
  35. data/docs/payment.md +3 -19
  36. data/docs/permission.md +4 -2
  37. data/docs/public_ip_address.md +2 -2
  38. data/docs/remote_server.md +15 -6
  39. data/docs/request.md +7 -6
  40. data/docs/settings_change.md +1 -1
  41. data/docs/sftp_host_key.md +6 -9
  42. data/docs/site.md +47 -114
  43. data/docs/sso_strategy.md +12 -12
  44. data/docs/status.md +4 -11
  45. data/docs/style.md +2 -2
  46. data/docs/usage_daily_snapshot.md +11 -9
  47. data/docs/usage_snapshot.md +3 -1
  48. data/docs/user.md +14 -8
  49. data/docs/user_request.md +1 -1
  50. data/docs/webhook_test.md +4 -4
  51. data/lib/files.com/models/site.rb +19 -0
  52. metadata +2 -2
data/docs/file.md CHANGED
@@ -23,13 +23,7 @@ may places where a Ruby File object can be used.
23
23
  "download_uri": "https://mysite.files.com/...",
24
24
  "priority_color": "red",
25
25
  "preview_id": 1,
26
- "preview": {
27
- "id": 1,
28
- "status": "complete",
29
- "download_uri": "https://mysite.files.com/...",
30
- "type": "image",
31
- "size": "large"
32
- }
26
+ "preview": ""
33
27
  }
34
28
  ```
35
29
 
data/docs/file_action.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "status": "pending",
8
- "file_migration_id": "123"
8
+ "file_migration_id": 1
9
9
  }
10
10
  ```
11
11
 
data/docs/file_comment.md CHANGED
@@ -7,10 +7,7 @@
7
7
  "id": 1,
8
8
  "body": "What a great file!",
9
9
  "reactions": [
10
- {
11
- "id": 1,
12
- "emoji": "👍"
13
- }
10
+ null
14
11
  ]
15
12
  }
16
13
  ```
@@ -4,21 +4,27 @@
4
4
 
5
5
  ```
6
6
  {
7
- "send": "",
7
+ "send": {
8
+ "key": "example value"
9
+ },
8
10
  "action": "multipart",
9
11
  "ask_about_overwrites": true,
10
12
  "available_parts": 1,
11
- "expires": "",
12
- "headers": "",
13
+ "expires": "example",
14
+ "headers": {
15
+ "key": "example value"
16
+ },
13
17
  "http_method": "PUT",
14
18
  "next_partsize": 1,
15
19
  "parallel_parts": true,
16
- "parameters": "{}",
20
+ "parameters": {
21
+ "key": "example value"
22
+ },
17
23
  "part_number": 1,
18
24
  "partsize": 1,
19
25
  "path": "",
20
26
  "ref": "upload-1",
21
- "upload_uri": ""
27
+ "upload_uri": "example"
22
28
  }
23
29
  ```
24
30
 
data/docs/folder.md CHANGED
@@ -25,13 +25,7 @@ Files::Dir is an alias of Files::Folder
25
25
  "download_uri": "https://mysite.files.com/...",
26
26
  "priority_color": "red",
27
27
  "preview_id": 1,
28
- "preview": {
29
- "id": 1,
30
- "status": "complete",
31
- "download_uri": "https://mysite.files.com/...",
32
- "type": "image",
33
- "size": "large"
34
- }
28
+ "preview": ""
35
29
  }
36
30
  ```
37
31
 
@@ -13,20 +13,7 @@
13
13
  4
14
14
  ],
15
15
  "form_fields": [
16
- {
17
- "id": 1,
18
- "label": "Sample Label",
19
- "required": true,
20
- "help_text": "Help Text",
21
- "field_type": "text",
22
- "options_for_select": [
23
- "red",
24
- "green",
25
- "blue"
26
- ],
27
- "default_option": "red",
28
- "form_field_set_id": 1
29
- }
16
+ null
30
17
  ],
31
18
  "skip_name": true,
32
19
  "skip_email": true,
@@ -86,7 +73,7 @@ Files::FormFieldSet.create(
86
73
  skip_email: true,
87
74
  skip_name: true,
88
75
  skip_company: true,
89
- 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}]
76
+ form_fields: [null]
90
77
  )
91
78
  ```
92
79
 
@@ -110,7 +97,7 @@ Files::FormFieldSet.update(id,
110
97
  skip_email: true,
111
98
  skip_name: true,
112
99
  skip_company: true,
113
- 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}]
100
+ form_fields: [null]
114
101
  )
115
102
  ```
116
103
 
@@ -149,7 +136,7 @@ form_field_set.update(
149
136
  skip_email: true,
150
137
  skip_name: true,
151
138
  skip_company: true,
152
- 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}]
139
+ form_fields: [null]
153
140
  )
154
141
  ```
155
142
 
data/docs/group.md CHANGED
@@ -7,9 +7,9 @@
7
7
  "id": 1,
8
8
  "name": "owners",
9
9
  "admin_ids": "1",
10
- "notes": "",
10
+ "notes": "example",
11
11
  "user_ids": "1",
12
- "usernames": "user"
12
+ "usernames": "example"
13
13
  }
14
14
  ```
15
15
 
@@ -65,6 +65,7 @@ Files::Group.find(id)
65
65
  ```
66
66
  Files::Group.create(
67
67
  name: "owners",
68
+ notes: "example",
68
69
  user_ids: "1",
69
70
  admin_ids: "1"
70
71
  )
@@ -85,6 +86,7 @@ Files::Group.create(
85
86
  ```
86
87
  Files::Group.update(id,
87
88
  name: "owners",
89
+ notes: "example",
88
90
  user_ids: "1",
89
91
  admin_ids: "1"
90
92
  )
@@ -121,6 +123,7 @@ group = Files::Group.list.first
121
123
 
122
124
  group.update(
123
125
  name: "owners",
126
+ notes: "example",
124
127
  user_ids: "1",
125
128
  admin_ids: "1"
126
129
  )
data/docs/group_user.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ```
6
6
  {
7
- "group_name": "My Group",
7
+ "group_name": "example",
8
8
  "group_id": 1,
9
9
  "user_id": 1,
10
10
  "admin": true,
@@ -5,7 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "history_version": "20201213.2",
8
+ "history_version": "example",
9
9
  "start_at": "2000-01-01T01:00:00Z",
10
10
  "end_at": "2000-01-01T01:00:00Z",
11
11
  "status": "ready",
@@ -8,12 +8,14 @@
8
8
  "name": "account",
9
9
  "company": "Action Verb",
10
10
  "email": "john.doe@files.com",
11
- "clickwrap_body": "",
11
+ "clickwrap_body": "example",
12
12
  "form_field_set_id": 1,
13
- "form_field_data": "",
13
+ "form_field_data": {
14
+ "key": "example value"
15
+ },
14
16
  "inbox_id": 1,
15
17
  "inbox_recipient_id": 1,
16
- "inbox_title": ""
18
+ "inbox_title": "example"
17
19
  }
18
20
  ```
19
21
 
data/docs/inbox_upload.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  ```
6
6
  {
7
- "inbox_registration": "",
7
+ "inbox_registration": "example",
8
8
  "path": "a/b/test.txt",
9
- "created_at": "2020-01-01 00:00:00"
9
+ "created_at": "2000-01-01T01:00:00Z"
10
10
  }
11
11
  ```
12
12
 
data/docs/invoice.md CHANGED
@@ -11,30 +11,14 @@
11
11
  "currency": "USD",
12
12
  "download_uri": "https://url...",
13
13
  "invoice_line_items": [
14
- {
15
- "amount": 1.0,
16
- "created_at": "2000-01-01T01:00:00Z",
17
- "description": "Service from 2019-01-01 through 2019-12-31",
18
- "type": "invoice",
19
- "service_end_at": "2000-01-01T01:00:00Z",
20
- "service_start_at": "2000-01-01T01:00:00Z",
21
- "updated_at": "2000-01-01T01:00:00Z",
22
- "plan": "Premier",
23
- "site": "My site"
24
- }
14
+ null
25
15
  ],
26
16
  "method": "paypal",
27
17
  "payment_line_items": [
28
- {
29
- "amount": 1.0,
30
- "created_at": "2000-01-01T01:00:00Z",
31
- "invoice_id": 1,
32
- "payment_id": 1,
33
- "updated_at": "2000-01-01T01:00:00Z"
34
- }
18
+ null
35
19
  ],
36
20
  "payment_reversed_at": "2000-01-01T01:00:00Z",
37
- "payment_type": "",
21
+ "payment_type": "example",
38
22
  "site_name": "My Site",
39
23
  "type": "invoice",
40
24
  "updated_at": "2000-01-01T01:00:00Z"
data/docs/lock.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "path": "locked_file",
8
- "timeout": 43200,
8
+ "timeout": 1,
9
9
  "depth": "infinity",
10
10
  "recursive": true,
11
11
  "owner": "user",
data/docs/message.md CHANGED
@@ -8,16 +8,7 @@
8
8
  "subject": "Files.com Account Upgrade",
9
9
  "body": "We should upgrade our Files.com account!",
10
10
  "comments": [
11
- {
12
- "id": 1,
13
- "body": "What a great idea, thank you!",
14
- "reactions": [
15
- {
16
- "id": 1,
17
- "emoji": "👍"
18
- }
19
- ]
20
- }
11
+ null
21
12
  ]
22
13
  }
23
14
  ```
@@ -7,10 +7,7 @@
7
7
  "id": 1,
8
8
  "body": "What a great idea, thank you!",
9
9
  "reactions": [
10
- {
11
- "id": 1,
12
- "emoji": "👍"
13
- }
10
+ null
14
11
  ]
15
12
  }
16
13
  ```
data/docs/notification.md CHANGED
@@ -7,7 +7,7 @@
7
7
  "id": 1,
8
8
  "path": "",
9
9
  "group_id": 1,
10
- "group_name": "",
10
+ "group_name": "example",
11
11
  "triggering_group_ids": [
12
12
  1
13
13
  ],
@@ -29,7 +29,7 @@
29
29
  "notify_file.txt"
30
30
  ],
31
31
  "unsubscribed": true,
32
- "unsubscribed_reason": "",
32
+ "unsubscribed_reason": "example",
33
33
  "user_id": 1,
34
34
  "username": "User",
35
35
  "suppressed_email": true
data/docs/payment.md CHANGED
@@ -11,30 +11,14 @@
11
11
  "currency": "USD",
12
12
  "download_uri": "https://url...",
13
13
  "invoice_line_items": [
14
- {
15
- "amount": 1.0,
16
- "created_at": "2000-01-01T01:00:00Z",
17
- "description": "Service from 2019-01-01 through 2019-12-31",
18
- "type": "invoice",
19
- "service_end_at": "2000-01-01T01:00:00Z",
20
- "service_start_at": "2000-01-01T01:00:00Z",
21
- "updated_at": "2000-01-01T01:00:00Z",
22
- "plan": "Premier",
23
- "site": "My site"
24
- }
14
+ null
25
15
  ],
26
16
  "method": "paypal",
27
17
  "payment_line_items": [
28
- {
29
- "amount": 1.0,
30
- "created_at": "2000-01-01T01:00:00Z",
31
- "invoice_id": 1,
32
- "payment_id": 1,
33
- "updated_at": "2000-01-01T01:00:00Z"
34
- }
18
+ null
35
19
  ],
36
20
  "payment_reversed_at": "2000-01-01T01:00:00Z",
37
- "payment_type": "",
21
+ "payment_type": "example",
38
22
  "site_name": "My Site",
39
23
  "type": "invoice",
40
24
  "updated_at": "2000-01-01T01:00:00Z"
data/docs/permission.md CHANGED
@@ -5,11 +5,11 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "path": "",
8
+ "path": "example",
9
9
  "user_id": 1,
10
10
  "username": "Sser",
11
11
  "group_id": 1,
12
- "group_name": "",
12
+ "group_name": "example",
13
13
  "permission": "full",
14
14
  "recursive": true
15
15
  }
@@ -32,6 +32,7 @@
32
32
  ```
33
33
  Files::Permission.list(
34
34
  per_page: 1,
35
+ path: "example",
35
36
  group_id: 1,
36
37
  user_id: 1,
37
38
  include_groups: true
@@ -62,6 +63,7 @@ Files::Permission.list(
62
63
  ```
63
64
  Files::Permission.create(
64
65
  group_id: 1,
66
+ path: "example",
65
67
  permission: "full",
66
68
  recursive: true,
67
69
  user_id: 1,
@@ -6,8 +6,8 @@
6
6
  {
7
7
  "ip_address": "1.1.1.1",
8
8
  "server_name": "server-1",
9
- "ftp_enabled": "",
10
- "sftp_enabled": ""
9
+ "ftp_enabled": "example",
10
+ "sftp_enabled": "example"
11
11
  }
12
12
  ```
13
13
 
@@ -16,7 +16,7 @@
16
16
  "pinned_region": "us-east-1",
17
17
  "s3_bucket": "my-bucket",
18
18
  "s3_region": "us-east-1",
19
- "aws_access_key": "",
19
+ "aws_access_key": "example",
20
20
  "server_certificate": "require_match",
21
21
  "server_host_key": "[public key]",
22
22
  "server_type": "s3",
@@ -28,7 +28,7 @@
28
28
  "backblaze_b2_bucket": "my-bucket",
29
29
  "wasabi_bucket": "my-bucket",
30
30
  "wasabi_region": "us-west-1",
31
- "wasabi_access_key": "",
31
+ "wasabi_access_key": "example",
32
32
  "rackspace_username": "rackspaceuser",
33
33
  "rackspace_region": "dfw",
34
34
  "rackspace_container": "my-container",
@@ -45,7 +45,7 @@
45
45
  "s3_compatible_bucket": "my-bucket",
46
46
  "s3_compatible_endpoint": "mys3platform.com",
47
47
  "s3_compatible_region": "us-east-1",
48
- "s3_compatible_access_key": "",
48
+ "s3_compatible_access_key": "example",
49
49
  "enable_dedicated_ips": true
50
50
  }
51
51
  ```
@@ -144,6 +144,8 @@ Files::RemoteServer.find(id)
144
144
 
145
145
  ```
146
146
  Files::RemoteServer.create(
147
+ aws_access_key: "example",
148
+ wasabi_access_key: "example",
147
149
  reset_authentication: true,
148
150
  hostname: "remote-server.com",
149
151
  name: "My Remote server",
@@ -176,7 +178,8 @@ Files::RemoteServer.create(
176
178
  s3_compatible_bucket: "my-bucket",
177
179
  s3_compatible_endpoint: "mys3platform.com",
178
180
  s3_compatible_region: "us-east-1",
179
- enable_dedicated_ips: true
181
+ enable_dedicated_ips: true,
182
+ s3_compatible_access_key: "example"
180
183
  )
181
184
  ```
182
185
 
@@ -239,6 +242,8 @@ Files::RemoteServer.create(
239
242
 
240
243
  ```
241
244
  Files::RemoteServer.update(id,
245
+ aws_access_key: "example",
246
+ wasabi_access_key: "example",
242
247
  reset_authentication: true,
243
248
  hostname: "remote-server.com",
244
249
  name: "My Remote server",
@@ -271,7 +276,8 @@ Files::RemoteServer.update(id,
271
276
  s3_compatible_bucket: "my-bucket",
272
277
  s3_compatible_endpoint: "mys3platform.com",
273
278
  s3_compatible_region: "us-east-1",
274
- enable_dedicated_ips: true
279
+ enable_dedicated_ips: true,
280
+ s3_compatible_access_key: "example"
275
281
  )
276
282
  ```
277
283
 
@@ -350,6 +356,8 @@ Files::RemoteServer.delete(id)
350
356
  remote_server = Files::RemoteServer.list.first
351
357
 
352
358
  remote_server.update(
359
+ aws_access_key: "example",
360
+ wasabi_access_key: "example",
353
361
  reset_authentication: true,
354
362
  hostname: "remote-server.com",
355
363
  name: "My Remote server",
@@ -382,7 +390,8 @@ remote_server.update(
382
390
  s3_compatible_bucket: "my-bucket",
383
391
  s3_compatible_endpoint: "mys3platform.com",
384
392
  s3_compatible_region: "us-east-1",
385
- enable_dedicated_ips: true
393
+ enable_dedicated_ips: true,
394
+ s3_compatible_access_key: "example"
386
395
  )
387
396
  ```
388
397
 
data/docs/request.md CHANGED
@@ -5,11 +5,11 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "path": "",
9
- "source": "",
10
- "destination": "",
11
- "automation_id": "",
12
- "user_display_name": ""
8
+ "path": "example",
9
+ "source": "example",
10
+ "destination": "example",
11
+ "automation_id": "example",
12
+ "user_display_name": "example"
13
13
  }
14
14
  ```
15
15
 
@@ -30,7 +30,8 @@
30
30
  ```
31
31
  Files::Request.list(
32
32
  per_page: 1,
33
- mine: true
33
+ mine: true,
34
+ path: "example"
34
35
  )
35
36
  ```
36
37
 
@@ -5,7 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "changes": [
8
- ""
8
+ "example"
9
9
  ],
10
10
  "created_at": "2000-01-01T01:00:00Z",
11
11
  "user_id": 1,
@@ -5,9 +5,9 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "name": "",
9
- "fingerprint_md5": "",
10
- "fingerprint_sha256": ""
8
+ "name": "example",
9
+ "fingerprint_md5": "example",
10
+ "fingerprint_sha256": "example"
11
11
  }
12
12
  ```
13
13
 
@@ -53,8 +53,7 @@ Files::SftpHostKey.find(id)
53
53
 
54
54
  ```
55
55
  Files::SftpHostKey.create(
56
- name: "",
57
- private_key: ""
56
+ name: "example"
58
57
  )
59
58
  ```
60
59
 
@@ -70,8 +69,7 @@ Files::SftpHostKey.create(
70
69
 
71
70
  ```
72
71
  Files::SftpHostKey.update(id,
73
- name: "",
74
- private_key: ""
72
+ name: "example"
75
73
  )
76
74
  ```
77
75
 
@@ -103,8 +101,7 @@ Files::SftpHostKey.delete(id)
103
101
  sftp_host_key = Files::SftpHostKey.list.first
104
102
 
105
103
  sftp_host_key.update(
106
- name: "",
107
- private_key: ""
104
+ name: "example"
108
105
  )
109
106
  ```
110
107