files.com 1.1.597 → 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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 688e7875040976b74cdc2bf245f054fe4e005125685d27af769ad4a7cb9660c1
4
- data.tar.gz: 907bfe4f027b890868115ec5adef64664050bbd18b68397fc41d9a730e11ff78
3
+ metadata.gz: 4eb1e3edc5f2b456c8e477c29015566cb158904c76133f95c3b0f47280259c0f
4
+ data.tar.gz: 5dad72b649848fd879dce367f8d61e95ada837164d1f10791bfc12ceb07699ef
5
5
  SHA512:
6
- metadata.gz: 4393537027f1dc7f5fb31e6789a1202b8b80480af9896179ecf9e3433e6385c5e9fd0bcb774e6a293c05b7e07cb670105426df20c253a504bdea68a5d7a644e6
7
- data.tar.gz: bf9ccccbb7e6d3d01e3289a2c5afe1ddc355d62c3f8749e535025002b8cc3ae83757268c42f63e992c9175c4ff954c9ea1a1c9bdad071c6a08a72f2af6e52141
6
+ metadata.gz: 63d82719bd0f2a75d488ab6b56697a704bc9ab808b6720bdb067cafaedac3b3e18f3c0b114d8469f7fc4bc4fbf5ef3a35c959a1d2b106a987f78195779014ea5
7
+ data.tar.gz: efb2566edb01bc24fde3aae8522670c0ccf271bcf9db4f1869aa7cecdadad4b57364fe683980da8556fc4b1c6c7937517534bbed55555c3b2cd06bb040d1f33e
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.597
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
  ```
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
@@ -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
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.597"
4
+ VERSION = "1.1.598"
5
5
  end
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.597
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-06 00:00:00.000000000 Z
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