files.com 1.0.232 → 1.0.236
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/_VERSION +1 -1
- data/docs/automation.md +0 -8
- data/docs/remote_server.md +2 -0
- data/docs/sso_strategy.md +1 -1
- data/lib/files.com/models/automation.rb +0 -15
- data/lib/files.com/models/remote_server.rb +9 -0
- data/lib/files.com/models/sso_strategy.rb +1 -1
- data/lib/files.com.rb +0 -1
- metadata +2 -4
- data/docs/sync_job.md +0 -37
- data/lib/files.com/models/sync_job.rb +0 -58
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 552519b04a1256d02139b97b36d9c2d398b0b35aa06e934380b2c0e6dbcc48a9
|
|
4
|
+
data.tar.gz: 57a407a420d4f2646937ae647022f8b0f1ba8e93e8f0a52fe5fd413f1ad5fd36
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fd27015305911d0ed20e1dca918c11113d44a93587e57dc6888176ec4fba12704a8cc74ad20d941c9b62e79eef13340ab19419c7b9cb0698aa76e08a8f8fcf03
|
|
7
|
+
data.tar.gz: 653f9efbd638f7b202974897bbc70ac6af3f910f85fdac4c6c6a188e40b1a25ad33de8bece0554dbe013531ec9c3a40c5a50714014255016828e97e911fcb9df
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.236
|
data/docs/automation.md
CHANGED
|
@@ -40,7 +40,6 @@
|
|
|
40
40
|
],
|
|
41
41
|
"webhook_url": "https://app.files.com/api/webhooks/abc123",
|
|
42
42
|
"trigger_actions": "[ \"create\" ]",
|
|
43
|
-
"trigger_action_path": "path/to/file/or/folder",
|
|
44
43
|
"value": "{\"limit\": \"1\"}"
|
|
45
44
|
}
|
|
46
45
|
```
|
|
@@ -62,7 +61,6 @@
|
|
|
62
61
|
* `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
|
|
63
62
|
* `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
|
|
64
63
|
* `trigger_actions` (string): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
|
65
|
-
* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
66
64
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
67
65
|
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
|
68
66
|
|
|
@@ -120,7 +118,6 @@ Files::Automation.create(
|
|
|
120
118
|
schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
|
121
119
|
trigger: "realtime",
|
|
122
120
|
trigger_actions: "[ \"create\" ]",
|
|
123
|
-
trigger_action_path: "path/to/file/or/folder",
|
|
124
121
|
value: "{\"limit\": \"1\"}"
|
|
125
122
|
)
|
|
126
123
|
```
|
|
@@ -142,7 +139,6 @@ Files::Automation.create(
|
|
|
142
139
|
* `name` (string): Name for this automation.
|
|
143
140
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
144
141
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
|
145
|
-
* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
146
142
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
147
143
|
|
|
148
144
|
|
|
@@ -161,7 +157,6 @@ Files::Automation.update(id,
|
|
|
161
157
|
schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
|
162
158
|
trigger: "realtime",
|
|
163
159
|
trigger_actions: "[ \"create\" ]",
|
|
164
|
-
trigger_action_path: "path/to/file/or/folder",
|
|
165
160
|
value: "{\"limit\": \"1\"}"
|
|
166
161
|
)
|
|
167
162
|
```
|
|
@@ -184,7 +179,6 @@ Files::Automation.update(id,
|
|
|
184
179
|
* `name` (string): Name for this automation.
|
|
185
180
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
186
181
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
|
187
|
-
* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
188
182
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
189
183
|
|
|
190
184
|
|
|
@@ -218,7 +212,6 @@ automation.update(
|
|
|
218
212
|
schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
|
219
213
|
trigger: "realtime",
|
|
220
214
|
trigger_actions: "[ \"create\" ]",
|
|
221
|
-
trigger_action_path: "path/to/file/or/folder",
|
|
222
215
|
value: "{\"limit\": \"1\"}"
|
|
223
216
|
)
|
|
224
217
|
```
|
|
@@ -241,7 +234,6 @@ automation.update(
|
|
|
241
234
|
* `name` (string): Name for this automation.
|
|
242
235
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
243
236
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
|
244
|
-
* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
245
237
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
246
238
|
|
|
247
239
|
|
data/docs/remote_server.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
```
|
|
6
6
|
{
|
|
7
7
|
"id": 1,
|
|
8
|
+
"disabled": true,
|
|
8
9
|
"authentication_method": "password",
|
|
9
10
|
"hostname": "remote-server.com",
|
|
10
11
|
"remote_home_path": "/home/user1",
|
|
@@ -40,6 +41,7 @@
|
|
|
40
41
|
```
|
|
41
42
|
|
|
42
43
|
* `id` (int64): Remote server ID
|
|
44
|
+
* `disabled` (boolean): If true, this server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
|
|
43
45
|
* `authentication_method` (string): Type of authentication method
|
|
44
46
|
* `hostname` (string): Hostname or IP address
|
|
45
47
|
* `remote_home_path` (string): Initial home folder on remote server
|
data/docs/sso_strategy.md
CHANGED
|
@@ -85,7 +85,7 @@
|
|
|
85
85
|
* `provision_company` (string): Default company for auto provisioned users.
|
|
86
86
|
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
|
87
87
|
* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
|
|
88
|
-
* `enabled` (boolean): Is strategy enabled?
|
|
88
|
+
* `enabled` (boolean): Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
89
89
|
* `ldap_host` (string): LDAP host
|
|
90
90
|
* `ldap_host_2` (string): LDAP backup host
|
|
91
91
|
* `ldap_host_3` (string): LDAP backup host
|
|
@@ -162,15 +162,6 @@ module Files
|
|
|
162
162
|
@attributes[:trigger_actions] = value
|
|
163
163
|
end
|
|
164
164
|
|
|
165
|
-
# string - If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
166
|
-
def trigger_action_path
|
|
167
|
-
@attributes[:trigger_action_path]
|
|
168
|
-
end
|
|
169
|
-
|
|
170
|
-
def trigger_action_path=(value)
|
|
171
|
-
@attributes[:trigger_action_path] = value
|
|
172
|
-
end
|
|
173
|
-
|
|
174
165
|
# object - A Hash of attributes specific to the automation type.
|
|
175
166
|
def value
|
|
176
167
|
@attributes[:value]
|
|
@@ -205,7 +196,6 @@ module Files
|
|
|
205
196
|
# name - string - Name for this automation.
|
|
206
197
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
207
198
|
# trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
|
208
|
-
# trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
209
199
|
# value - object - A Hash of attributes specific to the automation type.
|
|
210
200
|
def update(params = {})
|
|
211
201
|
params ||= {}
|
|
@@ -226,7 +216,6 @@ module Files
|
|
|
226
216
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
227
217
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
|
228
218
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
|
|
229
|
-
raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
|
|
230
219
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
|
231
220
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
|
232
221
|
|
|
@@ -320,7 +309,6 @@ module Files
|
|
|
320
309
|
# name - string - Name for this automation.
|
|
321
310
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
322
311
|
# trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
|
323
|
-
# trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
324
312
|
# value - object - A Hash of attributes specific to the automation type.
|
|
325
313
|
def self.create(params = {}, options = {})
|
|
326
314
|
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
|
|
@@ -338,7 +326,6 @@ module Files
|
|
|
338
326
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
339
327
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
|
340
328
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
|
|
341
|
-
raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
|
|
342
329
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params.dig(:value) and !params.dig(:value).is_a?(Hash)
|
|
343
330
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
|
344
331
|
|
|
@@ -362,7 +349,6 @@ module Files
|
|
|
362
349
|
# name - string - Name for this automation.
|
|
363
350
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
364
351
|
# trigger_actions - array(string) - If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
|
365
|
-
# trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
366
352
|
# value - object - A Hash of attributes specific to the automation type.
|
|
367
353
|
def self.update(id, params = {}, options = {})
|
|
368
354
|
params ||= {}
|
|
@@ -383,7 +369,6 @@ module Files
|
|
|
383
369
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
384
370
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
|
385
371
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
|
|
386
|
-
raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
|
|
387
372
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params.dig(:value) and !params.dig(:value).is_a?(Hash)
|
|
388
373
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
|
389
374
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
|
@@ -18,6 +18,15 @@ module Files
|
|
|
18
18
|
@attributes[:id] = value
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
+
# boolean - If true, this server has been disabled due to failures. Make any change or set disabled to false to clear this flag.
|
|
22
|
+
def disabled
|
|
23
|
+
@attributes[:disabled]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def disabled=(value)
|
|
27
|
+
@attributes[:disabled] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
21
30
|
# string - Type of authentication method
|
|
22
31
|
def authentication_method
|
|
23
32
|
@attributes[:authentication_method]
|
|
@@ -184,7 +184,7 @@ module Files
|
|
|
184
184
|
@attributes[:ldap_domain]
|
|
185
185
|
end
|
|
186
186
|
|
|
187
|
-
# boolean - Is strategy enabled?
|
|
187
|
+
# boolean - Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
|
188
188
|
def enabled
|
|
189
189
|
@attributes[:enabled]
|
|
190
190
|
end
|
data/lib/files.com.rb
CHANGED
|
@@ -94,7 +94,6 @@ require "files.com/models/site"
|
|
|
94
94
|
require "files.com/models/sso_strategy"
|
|
95
95
|
require "files.com/models/status"
|
|
96
96
|
require "files.com/models/style"
|
|
97
|
-
require "files.com/models/sync_job"
|
|
98
97
|
require "files.com/models/usage_daily_snapshot"
|
|
99
98
|
require "files.com/models/usage_snapshot"
|
|
100
99
|
require "files.com/models/user"
|
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.236
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-01-
|
|
11
|
+
date: 2022-01-28 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|
|
@@ -154,7 +154,6 @@ files:
|
|
|
154
154
|
- docs/sso_strategy.md
|
|
155
155
|
- docs/status.md
|
|
156
156
|
- docs/style.md
|
|
157
|
-
- docs/sync_job.md
|
|
158
157
|
- docs/usage_daily_snapshot.md
|
|
159
158
|
- docs/usage_snapshot.md
|
|
160
159
|
- docs/user.md
|
|
@@ -236,7 +235,6 @@ files:
|
|
|
236
235
|
- lib/files.com/models/sso_strategy.rb
|
|
237
236
|
- lib/files.com/models/status.rb
|
|
238
237
|
- lib/files.com/models/style.rb
|
|
239
|
-
- lib/files.com/models/sync_job.rb
|
|
240
238
|
- lib/files.com/models/usage_daily_snapshot.rb
|
|
241
239
|
- lib/files.com/models/usage_snapshot.rb
|
|
242
240
|
- lib/files.com/models/user.rb
|
data/docs/sync_job.md
DELETED
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
# SyncJob
|
|
2
|
-
|
|
3
|
-
## Example SyncJob Object
|
|
4
|
-
|
|
5
|
-
```
|
|
6
|
-
{
|
|
7
|
-
"queued_at": "2000-01-01T01:00:00Z",
|
|
8
|
-
"updated_at": "2000-01-01T01:00:00Z",
|
|
9
|
-
"status": "",
|
|
10
|
-
"regional_worker_status": "",
|
|
11
|
-
"uuid": "",
|
|
12
|
-
"folder_behavior_id": 1
|
|
13
|
-
}
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
* `queued_at` (date-time): Job enqueued at
|
|
17
|
-
* `updated_at` (date-time): Job updated at
|
|
18
|
-
* `status` (string): Status of the job
|
|
19
|
-
* `regional_worker_status` (string): Most recent reported status of sync worker
|
|
20
|
-
* `uuid` (string):
|
|
21
|
-
* `folder_behavior_id` (int64):
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
---
|
|
25
|
-
|
|
26
|
-
## List Sync Jobs
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
Files::SyncJob.list(
|
|
30
|
-
per_page: 1
|
|
31
|
-
)
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
### Parameters
|
|
35
|
-
|
|
36
|
-
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
|
37
|
-
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Files
|
|
4
|
-
class SyncJob
|
|
5
|
-
attr_reader :options, :attributes
|
|
6
|
-
|
|
7
|
-
def initialize(attributes = {}, options = {})
|
|
8
|
-
@attributes = attributes || {}
|
|
9
|
-
@options = options || {}
|
|
10
|
-
end
|
|
11
|
-
|
|
12
|
-
# date-time - Job enqueued at
|
|
13
|
-
def queued_at
|
|
14
|
-
@attributes[:queued_at]
|
|
15
|
-
end
|
|
16
|
-
|
|
17
|
-
# date-time - Job updated at
|
|
18
|
-
def updated_at
|
|
19
|
-
@attributes[:updated_at]
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
# string - Status of the job
|
|
23
|
-
def status
|
|
24
|
-
@attributes[:status]
|
|
25
|
-
end
|
|
26
|
-
|
|
27
|
-
# string - Most recent reported status of sync worker
|
|
28
|
-
def regional_worker_status
|
|
29
|
-
@attributes[:regional_worker_status]
|
|
30
|
-
end
|
|
31
|
-
|
|
32
|
-
# string -
|
|
33
|
-
def uuid
|
|
34
|
-
@attributes[:uuid]
|
|
35
|
-
end
|
|
36
|
-
|
|
37
|
-
# int64 -
|
|
38
|
-
def folder_behavior_id
|
|
39
|
-
@attributes[:folder_behavior_id]
|
|
40
|
-
end
|
|
41
|
-
|
|
42
|
-
# Parameters:
|
|
43
|
-
# cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
|
44
|
-
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
45
|
-
def self.list(params = {}, options = {})
|
|
46
|
-
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
|
47
|
-
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
|
48
|
-
|
|
49
|
-
List.new(SyncJob, params) do
|
|
50
|
-
Api.send_request("/sync_jobs", :get, params, options)
|
|
51
|
-
end
|
|
52
|
-
end
|
|
53
|
-
|
|
54
|
-
def self.all(params = {}, options = {})
|
|
55
|
-
list(params, options)
|
|
56
|
-
end
|
|
57
|
-
end
|
|
58
|
-
end
|