files.com 1.1.596 → 1.1.598
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/sync.md +12 -13
- data/docs/sync_run.md +13 -1
- data/docs/sync_run_live_transfer.md +23 -0
- data/lib/files.com/models/sync.rb +0 -12
- data/lib/files.com/models/sync_run.rb +5 -0
- data/lib/files.com/models/sync_run_live_transfer.rb +47 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -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: 4eb1e3edc5f2b456c8e477c29015566cb158904c76133f95c3b0f47280259c0f
|
|
4
|
+
data.tar.gz: 5dad72b649848fd879dce367f8d61e95ada837164d1f10791bfc12ceb07699ef
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 63d82719bd0f2a75d488ab6b56697a704bc9ab808b6720bdb067cafaedac3b3e18f3c0b114d8469f7fc4bc4fbf5ef3a35c959a1d2b106a987f78195779014ea5
|
|
7
|
+
data.tar.gz: efb2566edb01bc24fde3aae8522670c0ccf271bcf9db4f1869aa7cecdadad4b57364fe683980da8556fc4b1c6c7937517534bbed55555c3b2cd06bb040d1f33e
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.598
|
data/docs/sync.md
CHANGED
|
@@ -68,7 +68,18 @@
|
|
|
68
68
|
"successful_files": 1,
|
|
69
69
|
"sync_id": 1,
|
|
70
70
|
"sync_name": "Azure to SharePoint Sync",
|
|
71
|
-
"updated_at": "2000-01-01T01:00:00Z"
|
|
71
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
|
72
|
+
"live_transfers": [
|
|
73
|
+
{
|
|
74
|
+
"path": "example",
|
|
75
|
+
"status": "example",
|
|
76
|
+
"bytes_copied": 1,
|
|
77
|
+
"bytes_total": 1,
|
|
78
|
+
"percentage": 1.0,
|
|
79
|
+
"eta": "example",
|
|
80
|
+
"started_at": "example"
|
|
81
|
+
}
|
|
82
|
+
]
|
|
72
83
|
}
|
|
73
84
|
}
|
|
74
85
|
```
|
|
@@ -144,7 +155,6 @@ Files::Sync.create(
|
|
|
144
155
|
description: "example",
|
|
145
156
|
dest_path: "example",
|
|
146
157
|
dest_remote_server_id: 1,
|
|
147
|
-
dest_site_id: 1,
|
|
148
158
|
disabled: true,
|
|
149
159
|
exclude_patterns: ["example"],
|
|
150
160
|
holiday_region: "us_dc",
|
|
@@ -158,7 +168,6 @@ Files::Sync.create(
|
|
|
158
168
|
schedule_times_of_day: ["06:30","14:30"],
|
|
159
169
|
src_path: "example",
|
|
160
170
|
src_remote_server_id: 1,
|
|
161
|
-
src_site_id: 1,
|
|
162
171
|
sync_interval_minutes: 1,
|
|
163
172
|
trigger: "example",
|
|
164
173
|
trigger_file: "example",
|
|
@@ -172,7 +181,6 @@ Files::Sync.create(
|
|
|
172
181
|
* `description` (string): Description for this sync job
|
|
173
182
|
* `dest_path` (string): Absolute destination path for the sync
|
|
174
183
|
* `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
|
|
175
|
-
* `dest_site_id` (int64): Destination site ID if syncing to a child or partner site
|
|
176
184
|
* `disabled` (boolean): Is this sync disabled?
|
|
177
185
|
* `exclude_patterns` (array(string)): Array of glob patterns to exclude
|
|
178
186
|
* `holiday_region` (string): If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
|
|
@@ -186,7 +194,6 @@ Files::Sync.create(
|
|
|
186
194
|
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
187
195
|
* `src_path` (string): Absolute source path for the sync
|
|
188
196
|
* `src_remote_server_id` (int64): Remote server ID for the source (if remote)
|
|
189
|
-
* `src_site_id` (int64): Source site ID if syncing from a child or partner site
|
|
190
197
|
* `sync_interval_minutes` (int64): Frequency in minutes between syncs. If set, this value must be greater than or equal to the `remote_sync_interval` value for the site's plan. If left blank, the plan's `remote_sync_interval` will be used. This setting is only used if `trigger` is empty.
|
|
191
198
|
* `trigger` (string): Trigger type: daily, custom_schedule, or manual
|
|
192
199
|
* `trigger_file` (string): Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
|
@@ -229,7 +236,6 @@ Files::Sync.update(id,
|
|
|
229
236
|
description: "example",
|
|
230
237
|
dest_path: "example",
|
|
231
238
|
dest_remote_server_id: 1,
|
|
232
|
-
dest_site_id: 1,
|
|
233
239
|
disabled: true,
|
|
234
240
|
exclude_patterns: ["example"],
|
|
235
241
|
holiday_region: "us_dc",
|
|
@@ -243,7 +249,6 @@ Files::Sync.update(id,
|
|
|
243
249
|
schedule_times_of_day: ["06:30","14:30"],
|
|
244
250
|
src_path: "example",
|
|
245
251
|
src_remote_server_id: 1,
|
|
246
|
-
src_site_id: 1,
|
|
247
252
|
sync_interval_minutes: 1,
|
|
248
253
|
trigger: "example",
|
|
249
254
|
trigger_file: "example"
|
|
@@ -257,7 +262,6 @@ Files::Sync.update(id,
|
|
|
257
262
|
* `description` (string): Description for this sync job
|
|
258
263
|
* `dest_path` (string): Absolute destination path for the sync
|
|
259
264
|
* `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
|
|
260
|
-
* `dest_site_id` (int64): Destination site ID if syncing to a child or partner site
|
|
261
265
|
* `disabled` (boolean): Is this sync disabled?
|
|
262
266
|
* `exclude_patterns` (array(string)): Array of glob patterns to exclude
|
|
263
267
|
* `holiday_region` (string): If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
|
|
@@ -271,7 +275,6 @@ Files::Sync.update(id,
|
|
|
271
275
|
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
272
276
|
* `src_path` (string): Absolute source path for the sync
|
|
273
277
|
* `src_remote_server_id` (int64): Remote server ID for the source (if remote)
|
|
274
|
-
* `src_site_id` (int64): Source site ID if syncing from a child or partner site
|
|
275
278
|
* `sync_interval_minutes` (int64): Frequency in minutes between syncs. If set, this value must be greater than or equal to the `remote_sync_interval` value for the site's plan. If left blank, the plan's `remote_sync_interval` will be used. This setting is only used if `trigger` is empty.
|
|
276
279
|
* `trigger` (string): Trigger type: daily, custom_schedule, or manual
|
|
277
280
|
* `trigger_file` (string): Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
|
@@ -332,7 +335,6 @@ sync.update(
|
|
|
332
335
|
description: "example",
|
|
333
336
|
dest_path: "example",
|
|
334
337
|
dest_remote_server_id: 1,
|
|
335
|
-
dest_site_id: 1,
|
|
336
338
|
disabled: true,
|
|
337
339
|
exclude_patterns: ["example"],
|
|
338
340
|
holiday_region: "us_dc",
|
|
@@ -346,7 +348,6 @@ sync.update(
|
|
|
346
348
|
schedule_times_of_day: ["06:30","14:30"],
|
|
347
349
|
src_path: "example",
|
|
348
350
|
src_remote_server_id: 1,
|
|
349
|
-
src_site_id: 1,
|
|
350
351
|
sync_interval_minutes: 1,
|
|
351
352
|
trigger: "example",
|
|
352
353
|
trigger_file: "example"
|
|
@@ -360,7 +361,6 @@ sync.update(
|
|
|
360
361
|
* `description` (string): Description for this sync job
|
|
361
362
|
* `dest_path` (string): Absolute destination path for the sync
|
|
362
363
|
* `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
|
|
363
|
-
* `dest_site_id` (int64): Destination site ID if syncing to a child or partner site
|
|
364
364
|
* `disabled` (boolean): Is this sync disabled?
|
|
365
365
|
* `exclude_patterns` (array(string)): Array of glob patterns to exclude
|
|
366
366
|
* `holiday_region` (string): If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
|
|
@@ -374,7 +374,6 @@ sync.update(
|
|
|
374
374
|
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
375
375
|
* `src_path` (string): Absolute source path for the sync
|
|
376
376
|
* `src_remote_server_id` (int64): Remote server ID for the source (if remote)
|
|
377
|
-
* `src_site_id` (int64): Source site ID if syncing from a child or partner site
|
|
378
377
|
* `sync_interval_minutes` (int64): Frequency in minutes between syncs. If set, this value must be greater than or equal to the `remote_sync_interval` value for the site's plan. If left blank, the plan's `remote_sync_interval` will be used. This setting is only used if `trigger` is empty.
|
|
379
378
|
* `trigger` (string): Trigger type: daily, custom_schedule, or manual
|
|
380
379
|
* `trigger_file` (string): Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
data/docs/sync_run.md
CHANGED
|
@@ -27,7 +27,18 @@
|
|
|
27
27
|
"successful_files": 1,
|
|
28
28
|
"sync_id": 1,
|
|
29
29
|
"sync_name": "Azure to SharePoint Sync",
|
|
30
|
-
"updated_at": "2000-01-01T01:00:00Z"
|
|
30
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
|
31
|
+
"live_transfers": [
|
|
32
|
+
{
|
|
33
|
+
"path": "example",
|
|
34
|
+
"status": "example",
|
|
35
|
+
"bytes_copied": 1,
|
|
36
|
+
"bytes_total": 1,
|
|
37
|
+
"percentage": 1.0,
|
|
38
|
+
"eta": "example",
|
|
39
|
+
"started_at": "example"
|
|
40
|
+
}
|
|
41
|
+
]
|
|
31
42
|
}
|
|
32
43
|
```
|
|
33
44
|
|
|
@@ -53,6 +64,7 @@
|
|
|
53
64
|
* `sync_id` (int64): ID of the Sync this run belongs to
|
|
54
65
|
* `sync_name` (string): Name of the Sync this run belongs to
|
|
55
66
|
* `updated_at` (date-time): When this run was last updated
|
|
67
|
+
* `live_transfers` (array(object)): Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
|
|
56
68
|
|
|
57
69
|
|
|
58
70
|
---
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SyncRunLiveTransfer
|
|
2
|
+
|
|
3
|
+
## Example SyncRunLiveTransfer Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"path": "example",
|
|
8
|
+
"status": "example",
|
|
9
|
+
"bytes_copied": 1,
|
|
10
|
+
"bytes_total": 1,
|
|
11
|
+
"percentage": 1.0,
|
|
12
|
+
"eta": "example",
|
|
13
|
+
"started_at": "example"
|
|
14
|
+
}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
* `path` (string): The file path being transferred. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
18
|
+
* `status` (string): Status of this individual transfer
|
|
19
|
+
* `bytes_copied` (int64): Bytes transferred so far
|
|
20
|
+
* `bytes_total` (int64): Total bytes of the file being transferred
|
|
21
|
+
* `percentage` (double): Transfer progress from 0.0 to 1.0
|
|
22
|
+
* `eta` (string): Estimated time remaining (human-readable)
|
|
23
|
+
* `started_at` (string): When this individual transfer started
|
|
@@ -298,7 +298,6 @@ module Files
|
|
|
298
298
|
# description - string - Description for this sync job
|
|
299
299
|
# dest_path - string - Absolute destination path for the sync
|
|
300
300
|
# dest_remote_server_id - int64 - Remote server ID for the destination (if remote)
|
|
301
|
-
# dest_site_id - int64 - Destination site ID if syncing to a child or partner site
|
|
302
301
|
# disabled - boolean - Is this sync disabled?
|
|
303
302
|
# exclude_patterns - array(string) - Array of glob patterns to exclude
|
|
304
303
|
# holiday_region - string - If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
|
|
@@ -312,7 +311,6 @@ module Files
|
|
|
312
311
|
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
313
312
|
# src_path - string - Absolute source path for the sync
|
|
314
313
|
# src_remote_server_id - int64 - Remote server ID for the source (if remote)
|
|
315
|
-
# src_site_id - int64 - Source site ID if syncing from a child or partner site
|
|
316
314
|
# sync_interval_minutes - int64 - Frequency in minutes between syncs. If set, this value must be greater than or equal to the `remote_sync_interval` value for the site's plan. If left blank, the plan's `remote_sync_interval` will be used. This setting is only used if `trigger` is empty.
|
|
317
315
|
# trigger - string - Trigger type: daily, custom_schedule, or manual
|
|
318
316
|
# trigger_file - string - Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
|
@@ -324,7 +322,6 @@ module Files
|
|
|
324
322
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
325
323
|
raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
|
|
326
324
|
raise InvalidParameterError.new("Bad parameter: dest_remote_server_id must be an Integer") if params[:dest_remote_server_id] and !params[:dest_remote_server_id].is_a?(Integer)
|
|
327
|
-
raise InvalidParameterError.new("Bad parameter: dest_site_id must be an Integer") if params[:dest_site_id] and !params[:dest_site_id].is_a?(Integer)
|
|
328
325
|
raise InvalidParameterError.new("Bad parameter: exclude_patterns must be an Array") if params[:exclude_patterns] and !params[:exclude_patterns].is_a?(Array)
|
|
329
326
|
raise InvalidParameterError.new("Bad parameter: holiday_region must be an String") if params[:holiday_region] and !params[:holiday_region].is_a?(String)
|
|
330
327
|
raise InvalidParameterError.new("Bad parameter: include_patterns must be an Array") if params[:include_patterns] and !params[:include_patterns].is_a?(Array)
|
|
@@ -336,7 +333,6 @@ module Files
|
|
|
336
333
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
337
334
|
raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
|
|
338
335
|
raise InvalidParameterError.new("Bad parameter: src_remote_server_id must be an Integer") if params[:src_remote_server_id] and !params[:src_remote_server_id].is_a?(Integer)
|
|
339
|
-
raise InvalidParameterError.new("Bad parameter: src_site_id must be an Integer") if params[:src_site_id] and !params[:src_site_id].is_a?(Integer)
|
|
340
336
|
raise InvalidParameterError.new("Bad parameter: sync_interval_minutes must be an Integer") if params[:sync_interval_minutes] and !params[:sync_interval_minutes].is_a?(Integer)
|
|
341
337
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
|
342
338
|
raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
|
|
@@ -412,7 +408,6 @@ module Files
|
|
|
412
408
|
# description - string - Description for this sync job
|
|
413
409
|
# dest_path - string - Absolute destination path for the sync
|
|
414
410
|
# dest_remote_server_id - int64 - Remote server ID for the destination (if remote)
|
|
415
|
-
# dest_site_id - int64 - Destination site ID if syncing to a child or partner site
|
|
416
411
|
# disabled - boolean - Is this sync disabled?
|
|
417
412
|
# exclude_patterns - array(string) - Array of glob patterns to exclude
|
|
418
413
|
# holiday_region - string - If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
|
|
@@ -426,7 +421,6 @@ module Files
|
|
|
426
421
|
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
427
422
|
# src_path - string - Absolute source path for the sync
|
|
428
423
|
# src_remote_server_id - int64 - Remote server ID for the source (if remote)
|
|
429
|
-
# src_site_id - int64 - Source site ID if syncing from a child or partner site
|
|
430
424
|
# sync_interval_minutes - int64 - Frequency in minutes between syncs. If set, this value must be greater than or equal to the `remote_sync_interval` value for the site's plan. If left blank, the plan's `remote_sync_interval` will be used. This setting is only used if `trigger` is empty.
|
|
431
425
|
# trigger - string - Trigger type: daily, custom_schedule, or manual
|
|
432
426
|
# trigger_file - string - Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
|
@@ -435,7 +429,6 @@ module Files
|
|
|
435
429
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
436
430
|
raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
|
|
437
431
|
raise InvalidParameterError.new("Bad parameter: dest_remote_server_id must be an Integer") if params[:dest_remote_server_id] and !params[:dest_remote_server_id].is_a?(Integer)
|
|
438
|
-
raise InvalidParameterError.new("Bad parameter: dest_site_id must be an Integer") if params[:dest_site_id] and !params[:dest_site_id].is_a?(Integer)
|
|
439
432
|
raise InvalidParameterError.new("Bad parameter: exclude_patterns must be an Array") if params[:exclude_patterns] and !params[:exclude_patterns].is_a?(Array)
|
|
440
433
|
raise InvalidParameterError.new("Bad parameter: holiday_region must be an String") if params[:holiday_region] and !params[:holiday_region].is_a?(String)
|
|
441
434
|
raise InvalidParameterError.new("Bad parameter: include_patterns must be an Array") if params[:include_patterns] and !params[:include_patterns].is_a?(Array)
|
|
@@ -447,7 +440,6 @@ module Files
|
|
|
447
440
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
448
441
|
raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
|
|
449
442
|
raise InvalidParameterError.new("Bad parameter: src_remote_server_id must be an Integer") if params[:src_remote_server_id] and !params[:src_remote_server_id].is_a?(Integer)
|
|
450
|
-
raise InvalidParameterError.new("Bad parameter: src_site_id must be an Integer") if params[:src_site_id] and !params[:src_site_id].is_a?(Integer)
|
|
451
443
|
raise InvalidParameterError.new("Bad parameter: sync_interval_minutes must be an Integer") if params[:sync_interval_minutes] and !params[:sync_interval_minutes].is_a?(Integer)
|
|
452
444
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
|
453
445
|
raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
|
|
@@ -484,7 +476,6 @@ module Files
|
|
|
484
476
|
# description - string - Description for this sync job
|
|
485
477
|
# dest_path - string - Absolute destination path for the sync
|
|
486
478
|
# dest_remote_server_id - int64 - Remote server ID for the destination (if remote)
|
|
487
|
-
# dest_site_id - int64 - Destination site ID if syncing to a child or partner site
|
|
488
479
|
# disabled - boolean - Is this sync disabled?
|
|
489
480
|
# exclude_patterns - array(string) - Array of glob patterns to exclude
|
|
490
481
|
# holiday_region - string - If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
|
|
@@ -498,7 +489,6 @@ module Files
|
|
|
498
489
|
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
499
490
|
# src_path - string - Absolute source path for the sync
|
|
500
491
|
# src_remote_server_id - int64 - Remote server ID for the source (if remote)
|
|
501
|
-
# src_site_id - int64 - Source site ID if syncing from a child or partner site
|
|
502
492
|
# sync_interval_minutes - int64 - Frequency in minutes between syncs. If set, this value must be greater than or equal to the `remote_sync_interval` value for the site's plan. If left blank, the plan's `remote_sync_interval` will be used. This setting is only used if `trigger` is empty.
|
|
503
493
|
# trigger - string - Trigger type: daily, custom_schedule, or manual
|
|
504
494
|
# trigger_file - string - Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
|
@@ -509,7 +499,6 @@ module Files
|
|
|
509
499
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
510
500
|
raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
|
|
511
501
|
raise InvalidParameterError.new("Bad parameter: dest_remote_server_id must be an Integer") if params[:dest_remote_server_id] and !params[:dest_remote_server_id].is_a?(Integer)
|
|
512
|
-
raise InvalidParameterError.new("Bad parameter: dest_site_id must be an Integer") if params[:dest_site_id] and !params[:dest_site_id].is_a?(Integer)
|
|
513
502
|
raise InvalidParameterError.new("Bad parameter: exclude_patterns must be an Array") if params[:exclude_patterns] and !params[:exclude_patterns].is_a?(Array)
|
|
514
503
|
raise InvalidParameterError.new("Bad parameter: holiday_region must be an String") if params[:holiday_region] and !params[:holiday_region].is_a?(String)
|
|
515
504
|
raise InvalidParameterError.new("Bad parameter: include_patterns must be an Array") if params[:include_patterns] and !params[:include_patterns].is_a?(Array)
|
|
@@ -521,7 +510,6 @@ module Files
|
|
|
521
510
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
522
511
|
raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
|
|
523
512
|
raise InvalidParameterError.new("Bad parameter: src_remote_server_id must be an Integer") if params[:src_remote_server_id] and !params[:src_remote_server_id].is_a?(Integer)
|
|
524
|
-
raise InvalidParameterError.new("Bad parameter: src_site_id must be an Integer") if params[:src_site_id] and !params[:src_site_id].is_a?(Integer)
|
|
525
513
|
raise InvalidParameterError.new("Bad parameter: sync_interval_minutes must be an Integer") if params[:sync_interval_minutes] and !params[:sync_interval_minutes].is_a?(Integer)
|
|
526
514
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
|
527
515
|
raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
|
|
@@ -119,6 +119,11 @@ module Files
|
|
|
119
119
|
@attributes[:updated_at]
|
|
120
120
|
end
|
|
121
121
|
|
|
122
|
+
# array(object) - Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
|
|
123
|
+
def live_transfers
|
|
124
|
+
@attributes[:live_transfers]
|
|
125
|
+
end
|
|
126
|
+
|
|
122
127
|
# Parameters:
|
|
123
128
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
124
129
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Files
|
|
4
|
+
class SyncRunLiveTransfer
|
|
5
|
+
attr_reader :options, :attributes
|
|
6
|
+
|
|
7
|
+
def initialize(attributes = {}, options = {})
|
|
8
|
+
@attributes = attributes || {}
|
|
9
|
+
@options = options || {}
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
# string - The file path being transferred. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
13
|
+
def path
|
|
14
|
+
@attributes[:path]
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# string - Status of this individual transfer
|
|
18
|
+
def status
|
|
19
|
+
@attributes[:status]
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
# int64 - Bytes transferred so far
|
|
23
|
+
def bytes_copied
|
|
24
|
+
@attributes[:bytes_copied]
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# int64 - Total bytes of the file being transferred
|
|
28
|
+
def bytes_total
|
|
29
|
+
@attributes[:bytes_total]
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# double - Transfer progress from 0.0 to 1.0
|
|
33
|
+
def percentage
|
|
34
|
+
@attributes[:percentage]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# string - Estimated time remaining (human-readable)
|
|
38
|
+
def eta
|
|
39
|
+
@attributes[:eta]
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
# string - When this individual transfer started
|
|
43
|
+
def started_at
|
|
44
|
+
@attributes[:started_at]
|
|
45
|
+
end
|
|
46
|
+
end
|
|
47
|
+
end
|
data/lib/files.com/version.rb
CHANGED
data/lib/files.com.rb
CHANGED
|
@@ -138,6 +138,7 @@ require "files.com/models/style"
|
|
|
138
138
|
require "files.com/models/sync"
|
|
139
139
|
require "files.com/models/sync_log"
|
|
140
140
|
require "files.com/models/sync_run"
|
|
141
|
+
require "files.com/models/sync_run_live_transfer"
|
|
141
142
|
require "files.com/models/usage_by_top_level_dir"
|
|
142
143
|
require "files.com/models/usage_daily_snapshot"
|
|
143
144
|
require "files.com/models/usage_snapshot"
|
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.1.
|
|
4
|
+
version: 1.1.598
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-04-
|
|
11
|
+
date: 2026-04-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|
|
@@ -277,6 +277,7 @@ files:
|
|
|
277
277
|
- docs/sync.md
|
|
278
278
|
- docs/sync_log.md
|
|
279
279
|
- docs/sync_run.md
|
|
280
|
+
- docs/sync_run_live_transfer.md
|
|
280
281
|
- docs/usage_by_top_level_dir.md
|
|
281
282
|
- docs/usage_daily_snapshot.md
|
|
282
283
|
- docs/usage_snapshot.md
|
|
@@ -403,6 +404,7 @@ files:
|
|
|
403
404
|
- lib/files.com/models/sync.rb
|
|
404
405
|
- lib/files.com/models/sync_log.rb
|
|
405
406
|
- lib/files.com/models/sync_run.rb
|
|
407
|
+
- lib/files.com/models/sync_run_live_transfer.rb
|
|
406
408
|
- lib/files.com/models/usage_by_top_level_dir.rb
|
|
407
409
|
- lib/files.com/models/usage_daily_snapshot.rb
|
|
408
410
|
- lib/files.com/models/usage_snapshot.rb
|