files.com 1.2.296 → 1.2.298
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.
- package/README.md +6 -1
- package/_VERSION +1 -1
- package/docs/Errors.md +6 -1
- package/docs/models/AccountLineItem.md +1 -0
- package/docs/models/Invoice.md +1 -0
- package/docs/models/InvoiceLineItem.md +2 -0
- package/docs/models/Payment.md +1 -0
- package/docs/models/Sync.md +68 -2
- package/docs/models/SyncRun.md +8 -6
- package/lib/Errors.js +598 -538
- package/lib/Files.js +1 -1
- package/lib/models/InvoiceLineItem.js +4 -0
- package/lib/models/Sync.js +174 -118
- package/lib/models/SyncRun.js +23 -28
- package/package.json +1 -1
- package/src/Errors.js +6 -1
- package/src/Files.js +1 -1
- package/src/models/InvoiceLineItem.js +3 -0
- package/src/models/Sync.js +33 -0
- package/src/models/SyncRun.js +11 -14
package/README.md
CHANGED
|
@@ -667,12 +667,16 @@ Error
|
|
|
667
667
|
| `NotAuthorized_HistoryPermissionRequiredError`| `NotAuthorizedError` |
|
|
668
668
|
| `NotAuthorized_InsufficientPermissionForParamsError`| `NotAuthorizedError` |
|
|
669
669
|
| `NotAuthorized_InsufficientPermissionForSiteError`| `NotAuthorizedError` |
|
|
670
|
+
| `NotAuthorized_MoverAccessDeniedError`| `NotAuthorizedError` |
|
|
671
|
+
| `NotAuthorized_MoverPackageRequiredError`| `NotAuthorizedError` |
|
|
670
672
|
| `NotAuthorized_MustAuthenticateWithApiKeyError`| `NotAuthorizedError` |
|
|
671
673
|
| `NotAuthorized_NeedAdminPermissionForInboxError`| `NotAuthorizedError` |
|
|
672
674
|
| `NotAuthorized_NonAdminsMustQueryByFolderOrPathError`| `NotAuthorizedError` |
|
|
673
675
|
| `NotAuthorized_NotAllowedToCreateBundleError`| `NotAuthorizedError` |
|
|
676
|
+
| `NotAuthorized_NotEnqueuableSyncError`| `NotAuthorizedError` |
|
|
674
677
|
| `NotAuthorized_PasswordChangeNotRequiredError`| `NotAuthorizedError` |
|
|
675
678
|
| `NotAuthorized_PasswordChangeRequiredError`| `NotAuthorizedError` |
|
|
679
|
+
| `NotAuthorized_PaymentMethodErrorError`| `NotAuthorizedError` |
|
|
676
680
|
| `NotAuthorized_ReadOnlySessionError`| `NotAuthorizedError` |
|
|
677
681
|
| `NotAuthorized_ReadPermissionRequiredError`| `NotAuthorizedError` |
|
|
678
682
|
| `NotAuthorized_ReauthenticationFailedError`| `NotAuthorizedError` |
|
|
@@ -698,6 +702,7 @@ Error
|
|
|
698
702
|
| `NotFound_PlanNotFoundError`| `NotFoundError` |
|
|
699
703
|
| `NotFound_SiteNotFoundError`| `NotFoundError` |
|
|
700
704
|
| `NotFound_UserNotFoundError`| `NotFoundError` |
|
|
705
|
+
| `ProcessingFailure_AgentUnavailableError`| `ProcessingFailureError` |
|
|
701
706
|
| `ProcessingFailure_AlreadyCompletedError`| `ProcessingFailureError` |
|
|
702
707
|
| `ProcessingFailure_AutomationCannotBeRunManuallyError`| `ProcessingFailureError` |
|
|
703
708
|
| `ProcessingFailure_BehaviorNotAllowedOnRemoteServerError`| `ProcessingFailureError` |
|
|
@@ -739,6 +744,7 @@ Error
|
|
|
739
744
|
| `ProcessingFailure_ResourceBelongsToParentSiteError`| `ProcessingFailureError` |
|
|
740
745
|
| `ProcessingFailure_ResourceLockedError`| `ProcessingFailureError` |
|
|
741
746
|
| `ProcessingFailure_SubfolderLockedError`| `ProcessingFailureError` |
|
|
747
|
+
| `ProcessingFailure_SyncInProgressError`| `ProcessingFailureError` |
|
|
742
748
|
| `ProcessingFailure_TwoFactorAuthenticationCodeAlreadySentError`| `ProcessingFailureError` |
|
|
743
749
|
| `ProcessingFailure_TwoFactorAuthenticationCountryBlacklistedError`| `ProcessingFailureError` |
|
|
744
750
|
| `ProcessingFailure_TwoFactorAuthenticationGeneralErrorError`| `ProcessingFailureError` |
|
|
@@ -752,7 +758,6 @@ Error
|
|
|
752
758
|
| `RateLimited_TooManyLoginAttemptsError`| `RateLimitedError` |
|
|
753
759
|
| `RateLimited_TooManyRequestsError`| `RateLimitedError` |
|
|
754
760
|
| `RateLimited_TooManySharesError`| `RateLimitedError` |
|
|
755
|
-
| `ServiceUnavailable_AgentUnavailableError`| `ServiceUnavailableError` |
|
|
756
761
|
| `ServiceUnavailable_AutomationsUnavailableError`| `ServiceUnavailableError` |
|
|
757
762
|
| `ServiceUnavailable_MigrationInProgressError`| `ServiceUnavailableError` |
|
|
758
763
|
| `ServiceUnavailable_SiteDisabledError`| `ServiceUnavailableError` |
|
package/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.2.
|
|
1
|
+
1.2.298
|
package/docs/Errors.md
CHANGED
|
@@ -127,12 +127,16 @@ These errors are derived from the error groups listed above.
|
|
|
127
127
|
### NotAuthorized_HistoryPermissionRequiredError
|
|
128
128
|
### NotAuthorized_InsufficientPermissionForParamsError
|
|
129
129
|
### NotAuthorized_InsufficientPermissionForSiteError
|
|
130
|
+
### NotAuthorized_MoverAccessDeniedError
|
|
131
|
+
### NotAuthorized_MoverPackageRequiredError
|
|
130
132
|
### NotAuthorized_MustAuthenticateWithApiKeyError
|
|
131
133
|
### NotAuthorized_NeedAdminPermissionForInboxError
|
|
132
134
|
### NotAuthorized_NonAdminsMustQueryByFolderOrPathError
|
|
133
135
|
### NotAuthorized_NotAllowedToCreateBundleError
|
|
136
|
+
### NotAuthorized_NotEnqueuableSyncError
|
|
134
137
|
### NotAuthorized_PasswordChangeNotRequiredError
|
|
135
138
|
### NotAuthorized_PasswordChangeRequiredError
|
|
139
|
+
### NotAuthorized_PaymentMethodErrorError
|
|
136
140
|
### NotAuthorized_ReadOnlySessionError
|
|
137
141
|
### NotAuthorized_ReadPermissionRequiredError
|
|
138
142
|
### NotAuthorized_ReauthenticationFailedError
|
|
@@ -158,6 +162,7 @@ These errors are derived from the error groups listed above.
|
|
|
158
162
|
### NotFound_PlanNotFoundError
|
|
159
163
|
### NotFound_SiteNotFoundError
|
|
160
164
|
### NotFound_UserNotFoundError
|
|
165
|
+
### ProcessingFailure_AgentUnavailableError
|
|
161
166
|
### ProcessingFailure_AlreadyCompletedError
|
|
162
167
|
### ProcessingFailure_AutomationCannotBeRunManuallyError
|
|
163
168
|
### ProcessingFailure_BehaviorNotAllowedOnRemoteServerError
|
|
@@ -199,6 +204,7 @@ These errors are derived from the error groups listed above.
|
|
|
199
204
|
### ProcessingFailure_ResourceBelongsToParentSiteError
|
|
200
205
|
### ProcessingFailure_ResourceLockedError
|
|
201
206
|
### ProcessingFailure_SubfolderLockedError
|
|
207
|
+
### ProcessingFailure_SyncInProgressError
|
|
202
208
|
### ProcessingFailure_TwoFactorAuthenticationCodeAlreadySentError
|
|
203
209
|
### ProcessingFailure_TwoFactorAuthenticationCountryBlacklistedError
|
|
204
210
|
### ProcessingFailure_TwoFactorAuthenticationGeneralErrorError
|
|
@@ -212,7 +218,6 @@ These errors are derived from the error groups listed above.
|
|
|
212
218
|
### RateLimited_TooManyLoginAttemptsError
|
|
213
219
|
### RateLimited_TooManyRequestsError
|
|
214
220
|
### RateLimited_TooManySharesError
|
|
215
|
-
### ServiceUnavailable_AgentUnavailableError
|
|
216
221
|
### ServiceUnavailable_AutomationsUnavailableError
|
|
217
222
|
### ServiceUnavailable_MigrationInProgressError
|
|
218
223
|
### ServiceUnavailable_SiteDisabledError
|
package/docs/models/Invoice.md
CHANGED
|
@@ -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
|
package/docs/models/Payment.md
CHANGED
package/docs/models/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
|
|
|
@@ -149,6 +175,21 @@ await Sync.create({
|
|
|
149
175
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
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
|
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## Dry Run Sync
|
|
181
|
+
|
|
182
|
+
```
|
|
183
|
+
const sync = await Sync.find(id)
|
|
184
|
+
|
|
185
|
+
await sync.dry_run()
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Parameters
|
|
189
|
+
|
|
190
|
+
* `id` (int64): Required - Sync ID.
|
|
191
|
+
|
|
192
|
+
|
|
152
193
|
---
|
|
153
194
|
|
|
154
195
|
## Manually Run Sync
|
|
@@ -257,7 +298,32 @@ await sync.update({
|
|
|
257
298
|
"14:30"
|
|
258
299
|
],
|
|
259
300
|
"schedule_time_zone": "Eastern Time (US & Canada)",
|
|
260
|
-
"holiday_region": "us_dc"
|
|
301
|
+
"holiday_region": "us_dc",
|
|
302
|
+
"latest_sync_run": {
|
|
303
|
+
"id": 1,
|
|
304
|
+
"sync_id": 1,
|
|
305
|
+
"site_id": 1,
|
|
306
|
+
"status": "example",
|
|
307
|
+
"src_remote_server_type": "example",
|
|
308
|
+
"dest_remote_server_type": "example",
|
|
309
|
+
"body": "example",
|
|
310
|
+
"event_errors": [
|
|
311
|
+
"example"
|
|
312
|
+
],
|
|
313
|
+
"compared_files": 1,
|
|
314
|
+
"compared_folders": 1,
|
|
315
|
+
"errored_files": 1,
|
|
316
|
+
"successful_files": 1,
|
|
317
|
+
"runtime": 1.0,
|
|
318
|
+
"log_url": "https://www.example.com/log_file.txt",
|
|
319
|
+
"completed_at": "2000-01-01T01:00:00Z",
|
|
320
|
+
"notified": true,
|
|
321
|
+
"dry_run": true,
|
|
322
|
+
"bytes_synced": 1,
|
|
323
|
+
"estimated_bytes_count": 1,
|
|
324
|
+
"created_at": "2000-01-01T01:00:00Z",
|
|
325
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
|
326
|
+
}
|
|
261
327
|
}
|
|
262
328
|
```
|
|
263
329
|
|
package/docs/models/SyncRun.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,7 +59,6 @@
|
|
|
55
59
|
```
|
|
56
60
|
await SyncRun.list({
|
|
57
61
|
'user_id': 1,
|
|
58
|
-
'sync_id': 1,
|
|
59
62
|
})
|
|
60
63
|
```
|
|
61
64
|
|
|
@@ -65,9 +68,8 @@ await 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 `
|
|
69
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `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
|
|