files.com 1.0.57 → 1.0.62

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.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/_VERSION +1 -1
  3. data/docs/api_key.md +4 -2
  4. data/docs/as2_key.md +4 -2
  5. data/docs/automation.md +4 -2
  6. data/docs/behavior.md +4 -2
  7. data/docs/bundle.md +6 -3
  8. data/docs/file.md +6 -3
  9. data/docs/file_action.md +6 -3
  10. data/docs/file_comment.md +4 -2
  11. data/docs/file_comment_reaction.md +2 -1
  12. data/docs/group.md +4 -2
  13. data/docs/group_user.md +4 -2
  14. data/docs/history_export.md +2 -1
  15. data/docs/lock.md +2 -1
  16. data/docs/message.md +4 -2
  17. data/docs/message_comment.md +4 -2
  18. data/docs/message_comment_reaction.md +2 -1
  19. data/docs/message_reaction.md +2 -1
  20. data/docs/notification.md +4 -2
  21. data/docs/project.md +4 -2
  22. data/docs/public_key.md +4 -2
  23. data/docs/remote_server.md +12 -2
  24. data/docs/request.md +2 -1
  25. data/docs/site.md +2 -2
  26. data/docs/sso_strategy.md +27 -1
  27. data/docs/style.md +4 -2
  28. data/docs/user.md +10 -5
  29. data/lib/files.com/models/api_key.rb +5 -5
  30. data/lib/files.com/models/as2_key.rb +5 -5
  31. data/lib/files.com/models/automation.rb +3 -3
  32. data/lib/files.com/models/behavior.rb +7 -6
  33. data/lib/files.com/models/bundle.rb +8 -8
  34. data/lib/files.com/models/dns_record.rb +2 -2
  35. data/lib/files.com/models/file.rb +9 -9
  36. data/lib/files.com/models/file_action.rb +6 -6
  37. data/lib/files.com/models/file_comment.rb +2 -2
  38. data/lib/files.com/models/file_comment_reaction.rb +2 -2
  39. data/lib/files.com/models/folder.rb +2 -2
  40. data/lib/files.com/models/group.rb +3 -3
  41. data/lib/files.com/models/group_user.rb +8 -8
  42. data/lib/files.com/models/history.rb +11 -11
  43. data/lib/files.com/models/history_export.rb +10 -10
  44. data/lib/files.com/models/invoice.rb +3 -3
  45. data/lib/files.com/models/ip_address.rb +2 -2
  46. data/lib/files.com/models/lock.rb +3 -3
  47. data/lib/files.com/models/message.rb +9 -9
  48. data/lib/files.com/models/message_comment.rb +6 -6
  49. data/lib/files.com/models/message_comment_reaction.rb +6 -6
  50. data/lib/files.com/models/message_reaction.rb +6 -6
  51. data/lib/files.com/models/notification.rb +7 -7
  52. data/lib/files.com/models/payment.rb +3 -3
  53. data/lib/files.com/models/permission.rb +5 -5
  54. data/lib/files.com/models/project.rb +3 -3
  55. data/lib/files.com/models/public_key.rb +5 -5
  56. data/lib/files.com/models/remote_server.rb +24 -9
  57. data/lib/files.com/models/request.rb +7 -7
  58. data/lib/files.com/models/site.rb +13 -13
  59. data/lib/files.com/models/sso_strategy.rb +68 -3
  60. data/lib/files.com/models/usage_daily_snapshot.rb +2 -2
  61. data/lib/files.com/models/usage_snapshot.rb +2 -2
  62. data/lib/files.com/models/user.rb +15 -15
  63. data/lib/files.com/models/user_cipher_use.rb +3 -3
  64. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ac6ea2ce8bcfb738a69660d7ed2ea33fb3a84d1706f214cdf651d2b1de9aa4a3
4
- data.tar.gz: '0959698685c4e22335c5fc61f6c2b31429d95d20869f43665e2d2f8994f45fe0'
3
+ metadata.gz: 47b2517c82f3f42d1734e705931677fb550521a147ce08000d01ef1404c29024
4
+ data.tar.gz: e7cbe0ac99053c1d156c57f8983ec58842552eef38d3e8b3e72faf8e4c262c8e
5
5
  SHA512:
6
- metadata.gz: 99cc494b5b40ff0ba5d33d2f83894197612cfeb75c7198493639902ff307bfe3404f39858b1449e4f71d0eb10d2f7c973e1fcc204116f40c4975b7988cf420fb
7
- data.tar.gz: 56165d8e87ed3c819165f22520fc696c8900d83d0858f2da1bff97b148d050760ca6c51e74ddb1d6039887577f41818dff3b23ea976447c3a19ee4c3e277b840
6
+ metadata.gz: a41ec5693d7f81ff075f8d3ad29f9b8e8fb047007ea0de0b2035b94bf9983bc1dd461f5fc06637628000dd9b815438c16a35bc4c35acdb94c801a0f6e69e94dc
7
+ data.tar.gz: 2e2091a78586c778fae7573569d03a019a9dd20a8cd78d34c75dcba404560b967bef6c1efc3da603cda03409d44dce82e6b515a0ec8d0982e18e457b9344619e
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.57
1
+ 1.0.62
@@ -158,7 +158,8 @@ Files::ApiKey.delete(id)
158
158
  ## Update Api Key
159
159
 
160
160
  ```
161
- api_key = Files::ApiKey.find(1)
161
+ api_key = Files::ApiKey.list_for(path).first
162
+
162
163
  api_key.update(
163
164
  name: "My Key",
164
165
  permission_set: "full",
@@ -179,7 +180,8 @@ api_key.update(
179
180
  ## Delete Api Key
180
181
 
181
182
  ```
182
- api_key = Files::ApiKey.find(1)
183
+ api_key = Files::ApiKey.list_for(path).first
184
+
183
185
  api_key.delete
184
186
  ```
185
187
 
@@ -105,7 +105,8 @@ Files::As2Key.delete(id)
105
105
  ## Update As2 Key
106
106
 
107
107
  ```
108
- as2_key = Files::As2Key.find(1)
108
+ as2_key = Files::As2Key.list_for(path).first
109
+
109
110
  as2_key.update(
110
111
  as2_partnership_name: "Test"
111
112
  )
@@ -122,7 +123,8 @@ as2_key.update(
122
123
  ## Delete As2 Key
123
124
 
124
125
  ```
125
- as2_key = Files::As2Key.find(1)
126
+ as2_key = Files::As2Key.list_for(path).first
127
+
126
128
  as2_key.delete
127
129
  ```
128
130
 
@@ -143,7 +143,8 @@ Files::Automation.delete(id)
143
143
  ## Update Automation
144
144
 
145
145
  ```
146
- automation = Files::Automation.find(1)
146
+ automation = Files::Automation.list_for(path).first
147
+
147
148
  automation.update(
148
149
  automation: "create_folder",
149
150
  source: "source",
@@ -171,7 +172,8 @@ automation.update(
171
172
  ## Delete Automation
172
173
 
173
174
  ```
174
- automation = Files::Automation.find(1)
175
+ automation = Files::Automation.list_for(path).first
176
+
175
177
  automation.delete
176
178
  ```
177
179
 
@@ -151,7 +151,8 @@ Files::Behavior.delete(id)
151
151
  ## Update Behavior
152
152
 
153
153
  ```
154
- behavior = Files::Behavior.find(1)
154
+ behavior = Files::Behavior.list_for(path).first
155
+
155
156
  behavior.update(
156
157
  value: "{\"method\": \"GET\"}"
157
158
  )
@@ -169,7 +170,8 @@ behavior.update(
169
170
  ## Delete Behavior
170
171
 
171
172
  ```
172
- behavior = Files::Behavior.find(1)
173
+ behavior = Files::Behavior.list_for(path).first
174
+
173
175
  behavior.delete
174
176
  ```
175
177
 
@@ -154,7 +154,8 @@ Files::Bundle.delete(id)
154
154
  ## Send email(s) with a link to bundle
155
155
 
156
156
  ```
157
- bundle = Files::Bundle.find(1)
157
+ bundle = Files::Bundle.list_for(path).first
158
+
158
159
  bundle.share(
159
160
  to: ["johndoe@gmail.com"],
160
161
  note: "Just a note."
@@ -173,7 +174,8 @@ bundle.share(
173
174
  ## Update Bundle
174
175
 
175
176
  ```
176
- bundle = Files::Bundle.find(1)
177
+ bundle = Files::Bundle.list_for(path).first
178
+
177
179
  bundle.update(
178
180
  password: "Password",
179
181
  expires_at: "2000-01-01T01:00:00Z",
@@ -198,7 +200,8 @@ bundle.update(
198
200
  ## Delete Bundle
199
201
 
200
202
  ```
201
- bundle = Files::Bundle.find(1)
203
+ bundle = Files::Bundle.list_for(path).first
204
+
202
205
  bundle.delete
203
206
  ```
204
207
 
@@ -150,7 +150,8 @@ Files::File.delete(path,
150
150
  ## Download file
151
151
 
152
152
  ```
153
- file = Files::File.find(1)
153
+ file = Files::File.list_for(path).first
154
+
154
155
  file.download(
155
156
  id: 1,
156
157
  with_previews: true,
@@ -172,7 +173,8 @@ file.download(
172
173
  ## Update file/folder metadata
173
174
 
174
175
  ```
175
- file = Files::File.find(1)
176
+ file = Files::File.list_for(path).first
177
+
176
178
  file.update(
177
179
  provided_mtime: "2000-01-01T01:00:00Z",
178
180
  priority_color: "red"
@@ -191,7 +193,8 @@ file.update(
191
193
  ## Delete file/folder
192
194
 
193
195
  ```
194
- file = Files::File.find(1)
196
+ file = Files::File.list_for(path).first
197
+
195
198
  file.delete(
196
199
  recursive: true
197
200
  )
@@ -63,7 +63,8 @@ Files::FileAction.begin_upload(path,
63
63
  ## Copy file/folder
64
64
 
65
65
  ```
66
- file_action = Files::FileAction.find(1)
66
+ file_action = Files::FileAction.list_for(path).first
67
+
67
68
  file_action.copy(
68
69
  destination: "destination"
69
70
  )
@@ -80,7 +81,8 @@ file_action.copy(
80
81
  ## Move file/folder
81
82
 
82
83
  ```
83
- file_action = Files::FileAction.find(1)
84
+ file_action = Files::FileAction.list_for(path).first
85
+
84
86
  file_action.move(
85
87
  destination: "destination"
86
88
  )
@@ -97,7 +99,8 @@ file_action.move(
97
99
  ## Begin file upload
98
100
 
99
101
  ```
100
- file_action = Files::FileAction.find(1)
102
+ file_action = Files::FileAction.list_for(path).first
103
+
101
104
  file_action.begin_upload(
102
105
  mkdir_parents: true,
103
106
  part: 1,
@@ -88,7 +88,8 @@ Files::FileComment.delete(id)
88
88
  ## Update File Comment
89
89
 
90
90
  ```
91
- file_comment = Files::FileComment.find(1)
91
+ file_comment = Files::FileComment.list_for(path).first
92
+
92
93
  file_comment.update(
93
94
  body: "body"
94
95
  )
@@ -105,7 +106,8 @@ file_comment.update(
105
106
  ## Delete File Comment
106
107
 
107
108
  ```
108
- file_comment = Files::FileComment.find(1)
109
+ file_comment = Files::FileComment.list_for(path).first
110
+
109
111
  file_comment.delete
110
112
  ```
111
113
 
@@ -52,7 +52,8 @@ Files::FileCommentReaction.delete(id)
52
52
  ## Delete File Comment Reaction
53
53
 
54
54
  ```
55
- file_comment_reaction = Files::FileCommentReaction.find(1)
55
+ file_comment_reaction = Files::FileCommentReaction.list_for(path).first
56
+
56
57
  file_comment_reaction.delete
57
58
  ```
58
59
 
@@ -114,7 +114,8 @@ Files::Group.delete(id)
114
114
  ## Update Group
115
115
 
116
116
  ```
117
- group = Files::Group.find(1)
117
+ group = Files::Group.list_for(path).first
118
+
118
119
  group.update(
119
120
  name: "owners"
120
121
  )
@@ -134,7 +135,8 @@ group.update(
134
135
  ## Delete Group
135
136
 
136
137
  ```
137
- group = Files::Group.find(1)
138
+ group = Files::Group.list_for(path).first
139
+
138
140
  group.delete
139
141
  ```
140
142
 
@@ -81,7 +81,8 @@ Files::GroupUser.delete(id)
81
81
  ## Update Group User
82
82
 
83
83
  ```
84
- group_user = Files::GroupUser.find(1)
84
+ group_user = Files::GroupUser.list_for(path).first
85
+
85
86
  group_user.update(
86
87
  group_id: 1,
87
88
  user_id: 1,
@@ -102,7 +103,8 @@ group_user.update(
102
103
  ## Delete Group User
103
104
 
104
105
  ```
105
- group_user = Files::GroupUser.find(1)
106
+ group_user = Files::GroupUser.list_for(path).first
107
+
106
108
  group_user.delete
107
109
  ```
108
110
 
@@ -164,7 +164,8 @@ Files::HistoryExport.delete(id)
164
164
  ## Delete History Export
165
165
 
166
166
  ```
167
- history_export = Files::HistoryExport.find(1)
167
+ history_export = Files::HistoryExport.list_for(path).first
168
+
168
169
  history_export.delete
169
170
  ```
170
171
 
@@ -85,7 +85,8 @@ Files::Lock.delete(path,
85
85
  ## Delete Lock
86
86
 
87
87
  ```
88
- lock = Files::Lock.find(1)
88
+ lock = Files::Lock.list_for(path).first
89
+
89
90
  lock.delete(
90
91
  token: "token"
91
92
  )
@@ -115,7 +115,8 @@ Files::Message.delete(id)
115
115
  ## Update Message
116
116
 
117
117
  ```
118
- message = Files::Message.find(1)
118
+ message = Files::Message.list_for(path).first
119
+
119
120
  message.update(
120
121
  project_id: 1,
121
122
  subject: "subject",
@@ -136,7 +137,8 @@ message.update(
136
137
  ## Delete Message
137
138
 
138
139
  ```
139
- message = Files::Message.find(1)
140
+ message = Files::Message.list_for(path).first
141
+
140
142
  message.delete
141
143
  ```
142
144
 
@@ -104,7 +104,8 @@ Files::MessageComment.delete(id)
104
104
  ## Update Message Comment
105
105
 
106
106
  ```
107
- message_comment = Files::MessageComment.find(1)
107
+ message_comment = Files::MessageComment.list_for(path).first
108
+
108
109
  message_comment.update(
109
110
  body: "body"
110
111
  )
@@ -121,7 +122,8 @@ message_comment.update(
121
122
  ## Delete Message Comment
122
123
 
123
124
  ```
124
- message_comment = Files::MessageComment.find(1)
125
+ message_comment = Files::MessageComment.list_for(path).first
126
+
125
127
  message_comment.delete
126
128
  ```
127
129
 
@@ -84,7 +84,8 @@ Files::MessageCommentReaction.delete(id)
84
84
  ## Delete Message Comment Reaction
85
85
 
86
86
  ```
87
- message_comment_reaction = Files::MessageCommentReaction.find(1)
87
+ message_comment_reaction = Files::MessageCommentReaction.list_for(path).first
88
+
88
89
  message_comment_reaction.delete
89
90
  ```
90
91
 
@@ -84,7 +84,8 @@ Files::MessageReaction.delete(id)
84
84
  ## Delete Message Reaction
85
85
 
86
86
  ```
87
- message_reaction = Files::MessageReaction.find(1)
87
+ message_reaction = Files::MessageReaction.list_for(path).first
88
+
88
89
  message_reaction.delete
89
90
  ```
90
91
 
@@ -133,7 +133,8 @@ Files::Notification.delete(id)
133
133
  ## Update Notification
134
134
 
135
135
  ```
136
- notification = Files::Notification.find(1)
136
+ notification = Files::Notification.list_for(path).first
137
+
137
138
  notification.update(
138
139
  notify_on_copy: true,
139
140
  notify_user_actions: true,
@@ -154,7 +155,8 @@ notification.update(
154
155
  ## Delete Notification
155
156
 
156
157
  ```
157
- notification = Files::Notification.find(1)
158
+ notification = Files::Notification.list_for(path).first
159
+
158
160
  notification.delete
159
161
  ```
160
162
 
@@ -93,7 +93,8 @@ Files::Project.delete(id)
93
93
  ## Update Project
94
94
 
95
95
  ```
96
- project = Files::Project.find(1)
96
+ project = Files::Project.list_for(path).first
97
+
97
98
  project.update(
98
99
  global_access: "global_access"
99
100
  )
@@ -110,7 +111,8 @@ project.update(
110
111
  ## Delete Project
111
112
 
112
113
  ```
113
- project = Files::Project.find(1)
114
+ project = Files::Project.list_for(path).first
115
+
114
116
  project.delete
115
117
  ```
116
118
 
@@ -105,7 +105,8 @@ Files::PublicKey.delete(id)
105
105
  ## Update Public Key
106
106
 
107
107
  ```
108
- public_key = Files::PublicKey.find(1)
108
+ public_key = Files::PublicKey.list_for(path).first
109
+
109
110
  public_key.update(
110
111
  title: "My Main Key"
111
112
  )
@@ -122,7 +123,8 @@ public_key.update(
122
123
  ## Delete Public Key
123
124
 
124
125
  ```
125
- public_key = Files::PublicKey.find(1)
126
+ public_key = Files::PublicKey.list_for(path).first
127
+
126
128
  public_key.delete
127
129
  ```
128
130
 
@@ -13,6 +13,7 @@
13
13
  "s3_bucket": "my-bucket",
14
14
  "s3_region": "us-east-1",
15
15
  "server_certificate": "[certificate]",
16
+ "server_host_key": "[public key]",
16
17
  "server_type": "s3",
17
18
  "ssl": "always",
18
19
  "username": "user",
@@ -34,6 +35,7 @@
34
35
  * `s3_bucket` (string): S3 bucket name
35
36
  * `s3_region` (string): S3 region
36
37
  * `server_certificate` (string): Remote server certificate
38
+ * `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
37
39
  * `server_type` (string): Remote server type.
38
40
  * `ssl` (string): Should we require SSL?
39
41
  * `username` (string): Remote server username. Not needed for S3 buckets.
@@ -98,6 +100,7 @@ Files::RemoteServer.create(
98
100
  s3_bucket: "my-bucket",
99
101
  s3_region: "us-east-1",
100
102
  server_certificate: "[certificate]",
103
+ server_host_key: "[public key]",
101
104
  server_type: "s3",
102
105
  ssl: "always",
103
106
  username: "user",
@@ -128,6 +131,7 @@ Files::RemoteServer.create(
128
131
  * `s3_bucket` (string): S3 bucket name
129
132
  * `s3_region` (string): S3 region
130
133
  * `server_certificate` (string): Remote server certificate
134
+ * `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
131
135
  * `server_type` (string): Remote server type.
132
136
  * `ssl` (string): Should we require SSL?
133
137
  * `username` (string): Remote server username. Not needed for S3 buckets.
@@ -152,6 +156,7 @@ Files::RemoteServer.update(id,
152
156
  s3_bucket: "my-bucket",
153
157
  s3_region: "us-east-1",
154
158
  server_certificate: "[certificate]",
159
+ server_host_key: "[public key]",
155
160
  server_type: "s3",
156
161
  ssl: "always",
157
162
  username: "user",
@@ -183,6 +188,7 @@ Files::RemoteServer.update(id,
183
188
  * `s3_bucket` (string): S3 bucket name
184
189
  * `s3_region` (string): S3 region
185
190
  * `server_certificate` (string): Remote server certificate
191
+ * `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
186
192
  * `server_type` (string): Remote server type.
187
193
  * `ssl` (string): Should we require SSL?
188
194
  * `username` (string): Remote server username. Not needed for S3 buckets.
@@ -212,7 +218,8 @@ Files::RemoteServer.delete(id)
212
218
  ## Update Remote Server
213
219
 
214
220
  ```
215
- remote_server = Files::RemoteServer.find(1)
221
+ remote_server = Files::RemoteServer.list_for(path).first
222
+
216
223
  remote_server.update(
217
224
  hostname: "remote-server.com",
218
225
  name: "My Remote server",
@@ -221,6 +228,7 @@ remote_server.update(
221
228
  s3_bucket: "my-bucket",
222
229
  s3_region: "us-east-1",
223
230
  server_certificate: "[certificate]",
231
+ server_host_key: "[public key]",
224
232
  server_type: "s3",
225
233
  ssl: "always",
226
234
  username: "user",
@@ -252,6 +260,7 @@ remote_server.update(
252
260
  * `s3_bucket` (string): S3 bucket name
253
261
  * `s3_region` (string): S3 region
254
262
  * `server_certificate` (string): Remote server certificate
263
+ * `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
255
264
  * `server_type` (string): Remote server type.
256
265
  * `ssl` (string): Should we require SSL?
257
266
  * `username` (string): Remote server username. Not needed for S3 buckets.
@@ -268,7 +277,8 @@ remote_server.update(
268
277
  ## Delete Remote Server
269
278
 
270
279
  ```
271
- remote_server = Files::RemoteServer.find(1)
280
+ remote_server = Files::RemoteServer.list_for(path).first
281
+
272
282
  remote_server.delete
273
283
  ```
274
284