files.com 1.1.311 → 1.1.313

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: dcd986035b0c8010a10db478a21a70f52ff7c42cc83bf2bd271c555f5ffc851c
4
- data.tar.gz: b9e9e651622d7ef6a0e8786c6dcb2d75517bca96ca86822f3d5277c02aabef19
3
+ metadata.gz: 109561e43c644adaa536edfa0d3076e36e1cd8f0c78b8814adaef66487300a65
4
+ data.tar.gz: 2eeb1820eb364f8aa688ca2ba80b80aa2c719add21c669c0713d07ec2cc65772
5
5
  SHA512:
6
- metadata.gz: 23a8f792e888de79ff91b7ab7bce6541fdcea25ec79e07a9fe36cd936b218236fceacedbf51a4850d63b23a0f58d27c9858d6ac2332831b36887911ea0d496f5
7
- data.tar.gz: 37e00b0c65517f52dd38c8f20e04daa24f3f299a173b5fb72218b3918c70b084e0bb822b1e581f7ec737416518e2a2f309624373cc30814e00d47ca58a1f4b12
6
+ metadata.gz: 54b2bd5da37678db6d13d961bf45086a842c5ed5bfe86cde17f50e39a8df5969176e67f4aeeee001735157f9f7d5dead345c95e22dc1c7378c33ea841996f124
7
+ data.tar.gz: 57af69fc1c816d6ed8e9fa0a1d5c4c64b95baa92e312efb34896d24ec3446766db4b736042d6358ee0547547d8e7151290f3999c92f93efa626711ff5687c798
data/README.md CHANGED
@@ -544,12 +544,16 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
544
544
  |`HistoryPermissionRequiredError`| `NotAuthorizedError` |
545
545
  |`InsufficientPermissionForParamsError`| `NotAuthorizedError` |
546
546
  |`InsufficientPermissionForSiteError`| `NotAuthorizedError` |
547
+ |`MoverAccessDeniedError`| `NotAuthorizedError` |
548
+ |`MoverPackageRequiredError`| `NotAuthorizedError` |
547
549
  |`MustAuthenticateWithApiKeyError`| `NotAuthorizedError` |
548
550
  |`NeedAdminPermissionForInboxError`| `NotAuthorizedError` |
549
551
  |`NonAdminsMustQueryByFolderOrPathError`| `NotAuthorizedError` |
550
552
  |`NotAllowedToCreateBundleError`| `NotAuthorizedError` |
553
+ |`NotEnqueuableSyncError`| `NotAuthorizedError` |
551
554
  |`PasswordChangeNotRequiredError`| `NotAuthorizedError` |
552
555
  |`PasswordChangeRequiredError`| `NotAuthorizedError` |
556
+ |`PaymentMethodErrorError`| `NotAuthorizedError` |
553
557
  |`ReadOnlySessionError`| `NotAuthorizedError` |
554
558
  |`ReadPermissionRequiredError`| `NotAuthorizedError` |
555
559
  |`ReauthenticationFailedError`| `NotAuthorizedError` |
@@ -575,6 +579,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
575
579
  |`PlanNotFoundError`| `NotFoundError` |
576
580
  |`SiteNotFoundError`| `NotFoundError` |
577
581
  |`UserNotFoundError`| `NotFoundError` |
582
+ |`AgentUnavailableError`| `ProcessingFailureError` |
578
583
  |`AlreadyCompletedError`| `ProcessingFailureError` |
579
584
  |`AutomationCannotBeRunManuallyError`| `ProcessingFailureError` |
580
585
  |`BehaviorNotAllowedOnRemoteServerError`| `ProcessingFailureError` |
@@ -616,6 +621,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
616
621
  |`ResourceBelongsToParentSiteError`| `ProcessingFailureError` |
617
622
  |`ResourceLockedError`| `ProcessingFailureError` |
618
623
  |`SubfolderLockedError`| `ProcessingFailureError` |
624
+ |`SyncInProgressError`| `ProcessingFailureError` |
619
625
  |`TwoFactorAuthenticationCodeAlreadySentError`| `ProcessingFailureError` |
620
626
  |`TwoFactorAuthenticationCountryBlacklistedError`| `ProcessingFailureError` |
621
627
  |`TwoFactorAuthenticationGeneralErrorError`| `ProcessingFailureError` |
@@ -629,7 +635,6 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
629
635
  |`TooManyLoginAttemptsError`| `RateLimitedError` |
630
636
  |`TooManyRequestsError`| `RateLimitedError` |
631
637
  |`TooManySharesError`| `RateLimitedError` |
632
- |`AgentUnavailableError`| `ServiceUnavailableError` |
633
638
  |`AutomationsUnavailableError`| `ServiceUnavailableError` |
634
639
  |`MigrationInProgressError`| `ServiceUnavailableError` |
635
640
  |`SiteDisabledError`| `ServiceUnavailableError` |
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.311
1
+ 1.1.313
@@ -12,6 +12,7 @@
12
12
  "download_uri": "https://url...",
13
13
  "invoice_line_items": [
14
14
  {
15
+ "id": 1,
15
16
  "amount": 1.0,
16
17
  "created_at": "2000-01-01T01:00:00Z",
17
18
  "description": "Service from 2019-01-01 through 2019-12-31",
data/docs/invoice.md CHANGED
@@ -12,6 +12,7 @@
12
12
  "download_uri": "https://url...",
13
13
  "invoice_line_items": [
14
14
  {
15
+ "id": 1,
15
16
  "amount": 1.0,
16
17
  "created_at": "2000-01-01T01:00:00Z",
17
18
  "description": "Service from 2019-01-01 through 2019-12-31",
@@ -4,6 +4,7 @@
4
4
 
5
5
  ```
6
6
  {
7
+ "id": 1,
7
8
  "amount": 1.0,
8
9
  "created_at": "2000-01-01T01:00:00Z",
9
10
  "description": "Service from 2019-01-01 through 2019-12-31",
@@ -15,6 +16,7 @@
15
16
  }
16
17
  ```
17
18
 
19
+ * `id` (int64): Invoice Line item Id
18
20
  * `amount` (double): Invoice line item amount
19
21
  * `created_at` (date-time): Invoice line item created at date/time
20
22
  * `description` (string): Invoice line item description
data/docs/payment.md CHANGED
@@ -12,6 +12,7 @@
12
12
  "download_uri": "https://url...",
13
13
  "invoice_line_items": [
14
14
  {
15
+ "id": 1,
15
16
  "amount": 1.0,
16
17
  "created_at": "2000-01-01T01:00:00Z",
17
18
  "description": "Service from 2019-01-01 through 2019-12-31",
data/docs/sync.md CHANGED
@@ -40,7 +40,32 @@
40
40
  "14:30"
41
41
  ],
42
42
  "schedule_time_zone": "Eastern Time (US & Canada)",
43
- "holiday_region": "us_dc"
43
+ "holiday_region": "us_dc",
44
+ "latest_sync_run": {
45
+ "id": 1,
46
+ "sync_id": 1,
47
+ "site_id": 1,
48
+ "status": "example",
49
+ "src_remote_server_type": "example",
50
+ "dest_remote_server_type": "example",
51
+ "body": "example",
52
+ "event_errors": [
53
+ "example"
54
+ ],
55
+ "compared_files": 1,
56
+ "compared_folders": 1,
57
+ "errored_files": 1,
58
+ "successful_files": 1,
59
+ "runtime": 1.0,
60
+ "log_url": "https://www.example.com/log_file.txt",
61
+ "completed_at": "2000-01-01T01:00:00Z",
62
+ "notified": true,
63
+ "dry_run": true,
64
+ "bytes_synced": 1,
65
+ "estimated_bytes_count": 1,
66
+ "created_at": "2000-01-01T01:00:00Z",
67
+ "updated_at": "2000-01-01T01:00:00Z"
68
+ }
44
69
  }
45
70
  ```
46
71
 
@@ -70,6 +95,7 @@
70
95
  * `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.
71
96
  * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
72
97
  * `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.
98
+ * `latest_sync_run` (SyncRun): The latest run of this sync
73
99
 
74
100
 
75
101
  ---
@@ -150,6 +176,19 @@ Files::Sync.create(
150
176
  * `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.
151
177
 
152
178
 
179
+ ---
180
+
181
+ ## Dry Run Sync
182
+
183
+ ```
184
+ Files::Sync.dry_run(id)
185
+ ```
186
+
187
+ ### Parameters
188
+
189
+ * `id` (int64): Required - Sync ID.
190
+
191
+
153
192
  ---
154
193
 
155
194
  ## Manually Run Sync
@@ -228,6 +267,21 @@ Files::Sync.delete(id)
228
267
  * `id` (int64): Required - Sync ID.
229
268
 
230
269
 
270
+ ---
271
+
272
+ ## Dry Run Sync
273
+
274
+ ```
275
+ sync = Files::Sync.find(id)
276
+
277
+ sync.dry_run
278
+ ```
279
+
280
+ ### Parameters
281
+
282
+ * `id` (int64): Required - Sync ID.
283
+
284
+
231
285
  ---
232
286
 
233
287
  ## Manually Run Sync
data/docs/sync_run.md CHANGED
@@ -14,7 +14,6 @@
14
14
  "event_errors": [
15
15
  "example"
16
16
  ],
17
- "bytes_synced": 1,
18
17
  "compared_files": 1,
19
18
  "compared_folders": 1,
20
19
  "errored_files": 1,
@@ -23,6 +22,9 @@
23
22
  "log_url": "https://www.example.com/log_file.txt",
24
23
  "completed_at": "2000-01-01T01:00:00Z",
25
24
  "notified": true,
25
+ "dry_run": true,
26
+ "bytes_synced": 1,
27
+ "estimated_bytes_count": 1,
26
28
  "created_at": "2000-01-01T01:00:00Z",
27
29
  "updated_at": "2000-01-01T01:00:00Z"
28
30
  }
@@ -36,7 +38,6 @@
36
38
  * `dest_remote_server_type` (string): Destination remote server type, if any
37
39
  * `body` (string): Log or summary body for this run
38
40
  * `event_errors` (array(string)): Array of errors encountered during the run
39
- * `bytes_synced` (int64): Total bytes synced in this run
40
41
  * `compared_files` (int64): Number of files compared
41
42
  * `compared_folders` (int64): Number of folders compared
42
43
  * `errored_files` (int64): Number of files that errored
@@ -45,6 +46,9 @@
45
46
  * `log_url` (string): Link to external log file.
46
47
  * `completed_at` (date-time): When this run was completed
47
48
  * `notified` (boolean): Whether notifications were sent for this run
49
+ * `dry_run` (boolean): Whether this run was a dry run (no actual changes made)
50
+ * `bytes_synced` (int64): Total bytes synced in this run
51
+ * `estimated_bytes_count` (int64): Estimated bytes count for this run
48
52
  * `created_at` (date-time): When this run was created
49
53
  * `updated_at` (date-time): When this run was last updated
50
54
 
@@ -55,8 +59,7 @@
55
59
 
56
60
  ```
57
61
  Files::SyncRun.list(
58
- user_id: 1,
59
- sync_id: 1
62
+ user_id: 1
60
63
  )
61
64
  ```
62
65
 
@@ -65,9 +68,8 @@ Files::SyncRun.list(
65
68
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
66
69
  * `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.
67
70
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
68
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `sync_id`, `created_at` or `status`.
69
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `sync_id`. Valid field combinations are `[ sync_id, status ]`.
70
- * `sync_id` (int64): Required - ID of the Sync this run belongs to
71
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `sync_id` or `created_at`.
72
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `dry_run` or `sync_id`. Valid field combinations are `[ sync_id, status ]`.
71
73
 
72
74
 
73
75
  ---
@@ -130,12 +130,16 @@ module Files
130
130
  class HistoryPermissionRequiredError < NotAuthorizedError; end
131
131
  class InsufficientPermissionForParamsError < NotAuthorizedError; end
132
132
  class InsufficientPermissionForSiteError < NotAuthorizedError; end
133
+ class MoverAccessDeniedError < NotAuthorizedError; end
134
+ class MoverPackageRequiredError < NotAuthorizedError; end
133
135
  class MustAuthenticateWithApiKeyError < NotAuthorizedError; end
134
136
  class NeedAdminPermissionForInboxError < NotAuthorizedError; end
135
137
  class NonAdminsMustQueryByFolderOrPathError < NotAuthorizedError; end
136
138
  class NotAllowedToCreateBundleError < NotAuthorizedError; end
139
+ class NotEnqueuableSyncError < NotAuthorizedError; end
137
140
  class PasswordChangeNotRequiredError < NotAuthorizedError; end
138
141
  class PasswordChangeRequiredError < NotAuthorizedError; end
142
+ class PaymentMethodErrorError < NotAuthorizedError; end
139
143
  class ReadOnlySessionError < NotAuthorizedError; end
140
144
  class ReadPermissionRequiredError < NotAuthorizedError; end
141
145
  class ReauthenticationFailedError < NotAuthorizedError; end
@@ -165,6 +169,7 @@ module Files
165
169
  class UserNotFoundError < NotFoundError; end
166
170
 
167
171
  class ProcessingFailureError < APIError; end
172
+ class AgentUnavailableError < ProcessingFailureError; end
168
173
  class AlreadyCompletedError < ProcessingFailureError; end
169
174
  class AutomationCannotBeRunManuallyError < ProcessingFailureError; end
170
175
  class BehaviorNotAllowedOnRemoteServerError < ProcessingFailureError; end
@@ -206,6 +211,7 @@ module Files
206
211
  class ResourceBelongsToParentSiteError < ProcessingFailureError; end
207
212
  class ResourceLockedError < ProcessingFailureError; end
208
213
  class SubfolderLockedError < ProcessingFailureError; end
214
+ class SyncInProgressError < ProcessingFailureError; end
209
215
  class TwoFactorAuthenticationCodeAlreadySentError < ProcessingFailureError; end
210
216
  class TwoFactorAuthenticationCountryBlacklistedError < ProcessingFailureError; end
211
217
  class TwoFactorAuthenticationGeneralErrorError < ProcessingFailureError; end
@@ -223,7 +229,6 @@ module Files
223
229
  class TooManySharesError < RateLimitedError; end
224
230
 
225
231
  class ServiceUnavailableError < APIError; end
226
- class AgentUnavailableError < ServiceUnavailableError; end
227
232
  class AutomationsUnavailableError < ServiceUnavailableError; end
228
233
  class MigrationInProgressError < ServiceUnavailableError; end
229
234
  class SiteDisabledError < ServiceUnavailableError; end
@@ -9,6 +9,11 @@ module Files
9
9
  @options = options || {}
10
10
  end
11
11
 
12
+ # int64 - Invoice Line item Id
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
12
17
  # double - Invoice line item amount
13
18
  def amount
14
19
  @attributes[:amount]
@@ -235,6 +235,26 @@ module Files
235
235
  @attributes[:holiday_region] = value
236
236
  end
237
237
 
238
+ # SyncRun - The latest run of this sync
239
+ def latest_sync_run
240
+ @attributes[:latest_sync_run]
241
+ end
242
+
243
+ def latest_sync_run=(value)
244
+ @attributes[:latest_sync_run] = value
245
+ end
246
+
247
+ # Dry Run Sync
248
+ def dry_run(params = {})
249
+ params ||= {}
250
+ params[:id] = @attributes[:id]
251
+ raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
252
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
253
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
254
+
255
+ Api.send_request("/syncs/#{@attributes[:id]}/dry_run", :post, params, @options)
256
+ end
257
+
238
258
  # Manually Run Sync
239
259
  def manual_run(params = {})
240
260
  params ||= {}
@@ -390,6 +410,17 @@ module Files
390
410
  Sync.new(response.data, options)
391
411
  end
392
412
 
413
+ # Dry Run Sync
414
+ def self.dry_run(id, params = {}, options = {})
415
+ params ||= {}
416
+ params[:id] = id
417
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
418
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
419
+
420
+ Api.send_request("/syncs/#{params[:id]}/dry_run", :post, params, options)
421
+ nil
422
+ end
423
+
393
424
  # Manually Run Sync
394
425
  def self.manual_run(id, params = {}, options = {})
395
426
  params ||= {}
@@ -49,11 +49,6 @@ module Files
49
49
  @attributes[:event_errors]
50
50
  end
51
51
 
52
- # int64 - Total bytes synced in this run
53
- def bytes_synced
54
- @attributes[:bytes_synced]
55
- end
56
-
57
52
  # int64 - Number of files compared
58
53
  def compared_files
59
54
  @attributes[:compared_files]
@@ -94,6 +89,21 @@ module Files
94
89
  @attributes[:notified]
95
90
  end
96
91
 
92
+ # boolean - Whether this run was a dry run (no actual changes made)
93
+ def dry_run
94
+ @attributes[:dry_run]
95
+ end
96
+
97
+ # int64 - Total bytes synced in this run
98
+ def bytes_synced
99
+ @attributes[:bytes_synced]
100
+ end
101
+
102
+ # int64 - Estimated bytes count for this run
103
+ def estimated_bytes_count
104
+ @attributes[:estimated_bytes_count]
105
+ end
106
+
97
107
  # date-time - When this run was created
98
108
  def created_at
99
109
  @attributes[:created_at]
@@ -108,17 +118,14 @@ module Files
108
118
  # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
109
119
  # 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.
110
120
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
111
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `sync_id`, `created_at` or `status`.
112
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `sync_id`. Valid field combinations are `[ sync_id, status ]`.
113
- # sync_id (required) - int64 - ID of the Sync this run belongs to
121
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `sync_id` or `created_at`.
122
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `dry_run` or `sync_id`. Valid field combinations are `[ sync_id, status ]`.
114
123
  def self.list(params = {}, options = {})
115
124
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
116
125
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
117
126
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
118
127
  raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
119
128
  raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
120
- raise InvalidParameterError.new("Bad parameter: sync_id must be an Integer") if params[:sync_id] and !params[:sync_id].is_a?(Integer)
121
- raise MissingParameterError.new("Parameter missing: sync_id") unless params[:sync_id]
122
129
 
123
130
  List.new(SyncRun, params) do
124
131
  Api.send_request("/sync_runs", :get, params, options)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.311"
4
+ VERSION = "1.1.313"
5
5
  end
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.311
4
+ version: 1.1.313
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-07-28 00:00:00.000000000 Z
11
+ date: 2025-08-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable