files.com 1.1.310 → 1.1.312

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: 6ce1185b83e43ac2f0ed150a9a155b9b185a5c507a336662d68ea32474163693
4
- data.tar.gz: 1b6381d8c2a4fbbaec22c4a59272028716cfe2a5457126a60d2f86a5ba2e2ac0
3
+ metadata.gz: 57b293b58c2c9f52486a25beb4b351b5f2eca0a81f3362a5e2cb7552abe0abc6
4
+ data.tar.gz: d08c623e72f43fccb0e529789e4b5ae30196841c64007e8d8b8d42d164962352
5
5
  SHA512:
6
- metadata.gz: 67e3746e74cec4bccfb809c4a266f942ba02ee0182d316913acf9a43b7a77d5afa9eb1de19c40bdbbeab6f5f3fa43117406a82c88f814ad666c55b8b6e64fc9a
7
- data.tar.gz: 3dd482ab685b322663c2b28a2ee657c65431537e77dc4d9c0255a1d92fc341cdc7bac6b31e61968eeb9902e8bf0b668921d24b7e0717431206b6fd8cf52e2323
6
+ metadata.gz: 9984a10abcb9a17122000d4c635c78493b29a9a201cf6a4882d00c532ba855596465f918a9d4e11902f7f351e01beee9b0ecc5d009f68ccefc0893aa179d1ac1
7
+ data.tar.gz: 3a668690605cce2d4ae0618f593bf358119a4db2210724a74c02f8e2898c4c750f437773cb5d182107941df3f7b9c32703202f62e8283bd7d4092784b7518ca7
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` |
@@ -616,6 +620,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
616
620
  |`ResourceBelongsToParentSiteError`| `ProcessingFailureError` |
617
621
  |`ResourceLockedError`| `ProcessingFailureError` |
618
622
  |`SubfolderLockedError`| `ProcessingFailureError` |
623
+ |`SyncInProgressError`| `ProcessingFailureError` |
619
624
  |`TwoFactorAuthenticationCodeAlreadySentError`| `ProcessingFailureError` |
620
625
  |`TwoFactorAuthenticationCountryBlacklistedError`| `ProcessingFailureError` |
621
626
  |`TwoFactorAuthenticationGeneralErrorError`| `ProcessingFailureError` |
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.310
1
+ 1.1.312
@@ -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",
@@ -30,9 +30,6 @@
30
30
  "wasabi_bucket": "my-bucket",
31
31
  "wasabi_region": "us-west-1",
32
32
  "wasabi_access_key": "example",
33
- "rackspace_username": "rackspaceuser",
34
- "rackspace_region": "dfw",
35
- "rackspace_container": "my-container",
36
33
  "auth_status": "in_setup",
37
34
  "auth_account_name": "me@example.com",
38
35
  "one_drive_account_type": "personal",
@@ -91,9 +88,6 @@
91
88
  * `wasabi_bucket` (string): Wasabi: Bucket name
92
89
  * `wasabi_region` (string): Wasabi: Region
93
90
  * `wasabi_access_key` (string): Wasabi: Access Key.
94
- * `rackspace_username` (string): Rackspace: username used to login to the Rackspace Cloud Control Panel.
95
- * `rackspace_region` (string): Rackspace: Three letter code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
96
- * `rackspace_container` (string): Rackspace: The name of the container (top level directory) where files will sync.
97
91
  * `auth_status` (string): Either `in_setup` or `complete`
98
92
  * `auth_account_name` (string): Describes the authorized account
99
93
  * `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
@@ -140,7 +134,6 @@
140
134
  * `google_cloud_storage_credentials_json` (string): Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
141
135
  * `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
142
136
  * `linode_secret_key` (string): Linode: Secret Key
143
- * `rackspace_api_key` (string): Rackspace: API key from the Rackspace Cloud Control Panel
144
137
  * `s3_compatible_secret_key` (string): S3-compatible: Secret Key
145
138
  * `wasabi_secret_key` (string): Wasabi: Secret Key
146
139
 
@@ -157,9 +150,9 @@ Files::RemoteServer.list
157
150
 
158
151
  * `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.
159
152
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
160
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
161
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ rackspace_container, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
162
- * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ rackspace_container, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
153
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
154
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
155
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
163
156
 
164
157
 
165
158
  ---
@@ -227,9 +220,6 @@ Files::RemoteServer.create(
227
220
  one_drive_account_type: "personal",
228
221
  pin_to_site_region: true,
229
222
  port: 1,
230
- rackspace_container: "my-container",
231
- rackspace_region: "dfw",
232
- rackspace_username: "rackspaceuser",
233
223
  s3_bucket: "my-bucket",
234
224
  s3_compatible_access_key: "example",
235
225
  s3_compatible_bucket: "my-bucket",
@@ -266,7 +256,6 @@ Files::RemoteServer.create(
266
256
  * `google_cloud_storage_credentials_json` (string): Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
267
257
  * `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
268
258
  * `linode_secret_key` (string): Linode: Secret Key
269
- * `rackspace_api_key` (string): Rackspace: API key from the Rackspace Cloud Control Panel
270
259
  * `s3_compatible_secret_key` (string): S3-compatible: Secret Key
271
260
  * `wasabi_secret_key` (string): Wasabi: Secret Key
272
261
  * `aws_access_key` (string): AWS Access Key.
@@ -301,9 +290,6 @@ Files::RemoteServer.create(
301
290
  * `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
302
291
  * `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
303
292
  * `port` (int64): Port for remote server. Not needed for S3.
304
- * `rackspace_container` (string): Rackspace: The name of the container (top level directory) where files will sync.
305
- * `rackspace_region` (string): Rackspace: Three letter code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
306
- * `rackspace_username` (string): Rackspace: username used to login to the Rackspace Cloud Control Panel.
307
293
  * `s3_bucket` (string): S3 bucket name
308
294
  * `s3_compatible_access_key` (string): S3-compatible: Access Key
309
295
  * `s3_compatible_bucket` (string): S3-compatible: Bucket name
@@ -395,9 +381,6 @@ Files::RemoteServer.update(id,
395
381
  one_drive_account_type: "personal",
396
382
  pin_to_site_region: true,
397
383
  port: 1,
398
- rackspace_container: "my-container",
399
- rackspace_region: "dfw",
400
- rackspace_username: "rackspaceuser",
401
384
  s3_bucket: "my-bucket",
402
385
  s3_compatible_access_key: "example",
403
386
  s3_compatible_bucket: "my-bucket",
@@ -435,7 +418,6 @@ Files::RemoteServer.update(id,
435
418
  * `google_cloud_storage_credentials_json` (string): Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
436
419
  * `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
437
420
  * `linode_secret_key` (string): Linode: Secret Key
438
- * `rackspace_api_key` (string): Rackspace: API key from the Rackspace Cloud Control Panel
439
421
  * `s3_compatible_secret_key` (string): S3-compatible: Secret Key
440
422
  * `wasabi_secret_key` (string): Wasabi: Secret Key
441
423
  * `aws_access_key` (string): AWS Access Key.
@@ -470,9 +452,6 @@ Files::RemoteServer.update(id,
470
452
  * `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
471
453
  * `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
472
454
  * `port` (int64): Port for remote server. Not needed for S3.
473
- * `rackspace_container` (string): Rackspace: The name of the container (top level directory) where files will sync.
474
- * `rackspace_region` (string): Rackspace: Three letter code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
475
- * `rackspace_username` (string): Rackspace: username used to login to the Rackspace Cloud Control Panel.
476
455
  * `s3_bucket` (string): S3 bucket name
477
456
  * `s3_compatible_access_key` (string): S3-compatible: Access Key
478
457
  * `s3_compatible_bucket` (string): S3-compatible: Bucket name
@@ -581,9 +560,6 @@ remote_server.update(
581
560
  one_drive_account_type: "personal",
582
561
  pin_to_site_region: true,
583
562
  port: 1,
584
- rackspace_container: "my-container",
585
- rackspace_region: "dfw",
586
- rackspace_username: "rackspaceuser",
587
563
  s3_bucket: "my-bucket",
588
564
  s3_compatible_access_key: "example",
589
565
  s3_compatible_bucket: "my-bucket",
@@ -621,7 +597,6 @@ remote_server.update(
621
597
  * `google_cloud_storage_credentials_json` (string): Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
622
598
  * `google_cloud_storage_s3_compatible_secret_key` (string): Google Cloud Storage: S3-compatible secret key
623
599
  * `linode_secret_key` (string): Linode: Secret Key
624
- * `rackspace_api_key` (string): Rackspace: API key from the Rackspace Cloud Control Panel
625
600
  * `s3_compatible_secret_key` (string): S3-compatible: Secret Key
626
601
  * `wasabi_secret_key` (string): Wasabi: Secret Key
627
602
  * `aws_access_key` (string): AWS Access Key.
@@ -656,9 +631,6 @@ remote_server.update(
656
631
  * `one_drive_account_type` (string): OneDrive: Either personal or business_other account types
657
632
  * `pin_to_site_region` (boolean): If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
658
633
  * `port` (int64): Port for remote server. Not needed for S3.
659
- * `rackspace_container` (string): Rackspace: The name of the container (top level directory) where files will sync.
660
- * `rackspace_region` (string): Rackspace: Three letter code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
661
- * `rackspace_username` (string): Rackspace: username used to login to the Rackspace Cloud Control Panel.
662
634
  * `s3_bucket` (string): S3 bucket name
663
635
  * `s3_compatible_access_key` (string): S3-compatible: Access Key
664
636
  * `s3_compatible_bucket` (string): S3-compatible: Bucket name
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
@@ -206,6 +210,7 @@ module Files
206
210
  class ResourceBelongsToParentSiteError < ProcessingFailureError; end
207
211
  class ResourceLockedError < ProcessingFailureError; end
208
212
  class SubfolderLockedError < ProcessingFailureError; end
213
+ class SyncInProgressError < ProcessingFailureError; end
209
214
  class TwoFactorAuthenticationCodeAlreadySentError < ProcessingFailureError; end
210
215
  class TwoFactorAuthenticationCountryBlacklistedError < ProcessingFailureError; end
211
216
  class TwoFactorAuthenticationGeneralErrorError < ProcessingFailureError; 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]
@@ -243,33 +243,6 @@ module Files
243
243
  @attributes[:wasabi_access_key] = value
244
244
  end
245
245
 
246
- # string - Rackspace: username used to login to the Rackspace Cloud Control Panel.
247
- def rackspace_username
248
- @attributes[:rackspace_username]
249
- end
250
-
251
- def rackspace_username=(value)
252
- @attributes[:rackspace_username] = value
253
- end
254
-
255
- # string - Rackspace: Three letter code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
256
- def rackspace_region
257
- @attributes[:rackspace_region]
258
- end
259
-
260
- def rackspace_region=(value)
261
- @attributes[:rackspace_region] = value
262
- end
263
-
264
- # string - Rackspace: The name of the container (top level directory) where files will sync.
265
- def rackspace_container
266
- @attributes[:rackspace_container]
267
- end
268
-
269
- def rackspace_container=(value)
270
- @attributes[:rackspace_container] = value
271
- end
272
-
273
246
  # string - Either `in_setup` or `complete`
274
247
  def auth_status
275
248
  @attributes[:auth_status]
@@ -684,15 +657,6 @@ module Files
684
657
  @attributes[:linode_secret_key] = value
685
658
  end
686
659
 
687
- # string - Rackspace: API key from the Rackspace Cloud Control Panel
688
- def rackspace_api_key
689
- @attributes[:rackspace_api_key]
690
- end
691
-
692
- def rackspace_api_key=(value)
693
- @attributes[:rackspace_api_key] = value
694
- end
695
-
696
660
  # string - S3-compatible: Secret Key
697
661
  def s3_compatible_secret_key
698
662
  @attributes[:s3_compatible_secret_key]
@@ -764,7 +728,6 @@ module Files
764
728
  # google_cloud_storage_credentials_json - string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
765
729
  # google_cloud_storage_s3_compatible_secret_key - string - Google Cloud Storage: S3-compatible secret key
766
730
  # linode_secret_key - string - Linode: Secret Key
767
- # rackspace_api_key - string - Rackspace: API key from the Rackspace Cloud Control Panel
768
731
  # s3_compatible_secret_key - string - S3-compatible: Secret Key
769
732
  # wasabi_secret_key - string - Wasabi: Secret Key
770
733
  # aws_access_key - string - AWS Access Key.
@@ -799,9 +762,6 @@ module Files
799
762
  # one_drive_account_type - string - OneDrive: Either personal or business_other account types
800
763
  # pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
801
764
  # port - int64 - Port for remote server. Not needed for S3.
802
- # rackspace_container - string - Rackspace: The name of the container (top level directory) where files will sync.
803
- # rackspace_region - string - Rackspace: Three letter code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
804
- # rackspace_username - string - Rackspace: username used to login to the Rackspace Cloud Control Panel.
805
765
  # s3_bucket - string - S3 bucket name
806
766
  # s3_compatible_access_key - string - S3-compatible: Access Key
807
767
  # s3_compatible_bucket - string - S3-compatible: Bucket name
@@ -837,7 +797,6 @@ module Files
837
797
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params[:google_cloud_storage_credentials_json] and !params[:google_cloud_storage_credentials_json].is_a?(String)
838
798
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_secret_key must be an String") if params[:google_cloud_storage_s3_compatible_secret_key] and !params[:google_cloud_storage_s3_compatible_secret_key].is_a?(String)
839
799
  raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
840
- raise InvalidParameterError.new("Bad parameter: rackspace_api_key must be an String") if params[:rackspace_api_key] and !params[:rackspace_api_key].is_a?(String)
841
800
  raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
842
801
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
843
802
  raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params[:aws_access_key] and !params[:aws_access_key].is_a?(String)
@@ -868,9 +827,6 @@ module Files
868
827
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
869
828
  raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params[:one_drive_account_type] and !params[:one_drive_account_type].is_a?(String)
870
829
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
871
- raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params[:rackspace_container] and !params[:rackspace_container].is_a?(String)
872
- raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params[:rackspace_region] and !params[:rackspace_region].is_a?(String)
873
- raise InvalidParameterError.new("Bad parameter: rackspace_username must be an String") if params[:rackspace_username] and !params[:rackspace_username].is_a?(String)
874
830
  raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params[:s3_bucket] and !params[:s3_bucket].is_a?(String)
875
831
  raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
876
832
  raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params[:s3_compatible_bucket] and !params[:s3_compatible_bucket].is_a?(String)
@@ -919,9 +875,9 @@ module Files
919
875
  # Parameters:
920
876
  # 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.
921
877
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
922
- # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
923
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ rackspace_container, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
924
- # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `rackspace_container`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ rackspace_container, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
878
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
879
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
880
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
925
881
  def self.list(params = {}, options = {})
926
882
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
927
883
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
@@ -984,7 +940,6 @@ module Files
984
940
  # google_cloud_storage_credentials_json - string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
985
941
  # google_cloud_storage_s3_compatible_secret_key - string - Google Cloud Storage: S3-compatible secret key
986
942
  # linode_secret_key - string - Linode: Secret Key
987
- # rackspace_api_key - string - Rackspace: API key from the Rackspace Cloud Control Panel
988
943
  # s3_compatible_secret_key - string - S3-compatible: Secret Key
989
944
  # wasabi_secret_key - string - Wasabi: Secret Key
990
945
  # aws_access_key - string - AWS Access Key.
@@ -1019,9 +974,6 @@ module Files
1019
974
  # one_drive_account_type - string - OneDrive: Either personal or business_other account types
1020
975
  # pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
1021
976
  # port - int64 - Port for remote server. Not needed for S3.
1022
- # rackspace_container - string - Rackspace: The name of the container (top level directory) where files will sync.
1023
- # rackspace_region - string - Rackspace: Three letter code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
1024
- # rackspace_username - string - Rackspace: username used to login to the Rackspace Cloud Control Panel.
1025
977
  # s3_bucket - string - S3 bucket name
1026
978
  # s3_compatible_access_key - string - S3-compatible: Access Key
1027
979
  # s3_compatible_bucket - string - S3-compatible: Bucket name
@@ -1053,7 +1005,6 @@ module Files
1053
1005
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params[:google_cloud_storage_credentials_json] and !params[:google_cloud_storage_credentials_json].is_a?(String)
1054
1006
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_secret_key must be an String") if params[:google_cloud_storage_s3_compatible_secret_key] and !params[:google_cloud_storage_s3_compatible_secret_key].is_a?(String)
1055
1007
  raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
1056
- raise InvalidParameterError.new("Bad parameter: rackspace_api_key must be an String") if params[:rackspace_api_key] and !params[:rackspace_api_key].is_a?(String)
1057
1008
  raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
1058
1009
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
1059
1010
  raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params[:aws_access_key] and !params[:aws_access_key].is_a?(String)
@@ -1084,9 +1035,6 @@ module Files
1084
1035
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
1085
1036
  raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params[:one_drive_account_type] and !params[:one_drive_account_type].is_a?(String)
1086
1037
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
1087
- raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params[:rackspace_container] and !params[:rackspace_container].is_a?(String)
1088
- raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params[:rackspace_region] and !params[:rackspace_region].is_a?(String)
1089
- raise InvalidParameterError.new("Bad parameter: rackspace_username must be an String") if params[:rackspace_username] and !params[:rackspace_username].is_a?(String)
1090
1038
  raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params[:s3_bucket] and !params[:s3_bucket].is_a?(String)
1091
1039
  raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
1092
1040
  raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params[:s3_compatible_bucket] and !params[:s3_compatible_bucket].is_a?(String)
@@ -1159,7 +1107,6 @@ module Files
1159
1107
  # google_cloud_storage_credentials_json - string - Google Cloud Storage: JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
1160
1108
  # google_cloud_storage_s3_compatible_secret_key - string - Google Cloud Storage: S3-compatible secret key
1161
1109
  # linode_secret_key - string - Linode: Secret Key
1162
- # rackspace_api_key - string - Rackspace: API key from the Rackspace Cloud Control Panel
1163
1110
  # s3_compatible_secret_key - string - S3-compatible: Secret Key
1164
1111
  # wasabi_secret_key - string - Wasabi: Secret Key
1165
1112
  # aws_access_key - string - AWS Access Key.
@@ -1194,9 +1141,6 @@ module Files
1194
1141
  # one_drive_account_type - string - OneDrive: Either personal or business_other account types
1195
1142
  # pin_to_site_region - boolean - If true, we will ensure that all communications with this remote server are made through the primary region of the site. This setting can also be overridden by a site-wide setting which will force it to true.
1196
1143
  # port - int64 - Port for remote server. Not needed for S3.
1197
- # rackspace_container - string - Rackspace: The name of the container (top level directory) where files will sync.
1198
- # rackspace_region - string - Rackspace: Three letter code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
1199
- # rackspace_username - string - Rackspace: username used to login to the Rackspace Cloud Control Panel.
1200
1144
  # s3_bucket - string - S3 bucket name
1201
1145
  # s3_compatible_access_key - string - S3-compatible: Access Key
1202
1146
  # s3_compatible_bucket - string - S3-compatible: Bucket name
@@ -1231,7 +1175,6 @@ module Files
1231
1175
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params[:google_cloud_storage_credentials_json] and !params[:google_cloud_storage_credentials_json].is_a?(String)
1232
1176
  raise InvalidParameterError.new("Bad parameter: google_cloud_storage_s3_compatible_secret_key must be an String") if params[:google_cloud_storage_s3_compatible_secret_key] and !params[:google_cloud_storage_s3_compatible_secret_key].is_a?(String)
1233
1177
  raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
1234
- raise InvalidParameterError.new("Bad parameter: rackspace_api_key must be an String") if params[:rackspace_api_key] and !params[:rackspace_api_key].is_a?(String)
1235
1178
  raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
1236
1179
  raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
1237
1180
  raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params[:aws_access_key] and !params[:aws_access_key].is_a?(String)
@@ -1262,9 +1205,6 @@ module Files
1262
1205
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
1263
1206
  raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params[:one_drive_account_type] and !params[:one_drive_account_type].is_a?(String)
1264
1207
  raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params[:port] and !params[:port].is_a?(Integer)
1265
- raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params[:rackspace_container] and !params[:rackspace_container].is_a?(String)
1266
- raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params[:rackspace_region] and !params[:rackspace_region].is_a?(String)
1267
- raise InvalidParameterError.new("Bad parameter: rackspace_username must be an String") if params[:rackspace_username] and !params[:rackspace_username].is_a?(String)
1268
1208
  raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params[:s3_bucket] and !params[:s3_bucket].is_a?(String)
1269
1209
  raise InvalidParameterError.new("Bad parameter: s3_compatible_access_key must be an String") if params[:s3_compatible_access_key] and !params[:s3_compatible_access_key].is_a?(String)
1270
1210
  raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params[:s3_compatible_bucket] and !params[:s3_compatible_bucket].is_a?(String)
@@ -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.310"
4
+ VERSION = "1.1.312"
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.310
4
+ version: 1.1.312
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-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable