files.com 1.0.190 → 1.0.191
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/Errors.md +186 -0
- package/docs/models/AccountLineItem.md +53 -0
- package/docs/models/Action.md +37 -0
- package/docs/models/ActionNotificationExport.md +82 -0
- package/docs/models/ActionNotificationExportResult.md +49 -0
- package/docs/models/ActionWebhookFailure.md +16 -0
- package/docs/models/ApiKey.md +183 -0
- package/docs/models/App.md +66 -0
- package/docs/models/As2IncomingMessage.md +104 -0
- package/docs/models/As2OutgoingMessage.md +96 -0
- package/docs/models/As2Partner.md +141 -0
- package/docs/models/As2Station.md +142 -0
- package/docs/models/Auto.md +11 -0
- package/docs/models/Automation.md +257 -0
- package/docs/models/AutomationRun.md +61 -0
- package/docs/models/BandwidthSnapshot.md +50 -0
- package/docs/models/Behavior.md +195 -0
- package/docs/models/Bundle.md +330 -0
- package/docs/models/BundleDownload.md +44 -0
- package/docs/models/BundleRecipient.md +76 -0
- package/docs/models/BundleRegistration.md +53 -0
- package/docs/models/Clickwrap.md +120 -0
- package/docs/models/DnsRecord.md +33 -0
- package/docs/models/Errors.md +17 -0
- package/docs/models/ExternalEvent.md +84 -0
- package/docs/models/File.md +339 -0
- package/docs/models/FileAction.md +13 -0
- package/docs/models/FileComment.md +98 -0
- package/docs/models/FileCommentReaction.md +50 -0
- package/docs/models/FileMigration.md +40 -0
- package/docs/models/FileUploadPart.md +39 -0
- package/docs/models/Folder.md +90 -0
- package/docs/models/FormField.md +29 -0
- package/docs/models/FormFieldSet.md +170 -0
- package/docs/models/Group.md +140 -0
- package/docs/models/GroupUser.md +116 -0
- package/docs/models/History.md +151 -0
- package/docs/models/HistoryExport.md +130 -0
- package/docs/models/HistoryExportResult.md +75 -0
- package/docs/models/Image.md +13 -0
- package/docs/models/InboxRecipient.md +76 -0
- package/docs/models/InboxRegistration.md +47 -0
- package/docs/models/InboxUpload.md +42 -0
- package/docs/models/Invoice.md +82 -0
- package/docs/models/InvoiceLineItem.md +27 -0
- package/docs/models/IpAddress.md +51 -0
- package/docs/models/Lock.md +92 -0
- package/docs/models/Message.md +134 -0
- package/docs/models/MessageComment.md +114 -0
- package/docs/models/MessageCommentReaction.md +79 -0
- package/docs/models/MessageReaction.md +79 -0
- package/docs/models/Notification.md +241 -0
- package/docs/models/Payment.md +82 -0
- package/docs/models/PaymentLineItem.md +19 -0
- package/docs/models/Permission.md +94 -0
- package/docs/models/Preview.md +19 -0
- package/docs/models/Priority.md +30 -0
- package/docs/models/Project.md +98 -0
- package/docs/models/PublicIpAddress.md +17 -0
- package/docs/models/PublicKey.md +112 -0
- package/docs/models/RemoteBandwidthSnapshot.md +42 -0
- package/docs/models/RemoteServer.md +385 -0
- package/docs/models/Request.md +97 -0
- package/docs/models/Session.md +50 -0
- package/docs/models/SettingsChange.md +44 -0
- package/docs/models/Site.md +607 -0
- package/docs/models/SsoStrategy.md +139 -0
- package/docs/models/Status.md +30 -0
- package/docs/models/Style.md +76 -0
- package/docs/models/UsageDailySnapshot.md +56 -0
- package/docs/models/UsageSnapshot.md +63 -0
- package/docs/models/User.md +465 -0
- package/docs/models/UserCipherUse.md +39 -0
- package/docs/models/UserRequest.md +80 -0
- package/docs/models/WebhookTest.md +59 -0
- package/lib/Api.js +12 -11
- package/lib/Errors.js +3126 -0
- package/lib/models/AccountLineItem.js +8 -0
- package/lib/models/Action.js +8 -0
- package/lib/models/ActionNotificationExport.js +21 -13
- package/lib/models/ActionNotificationExportResult.js +13 -5
- package/lib/models/ActionWebhookFailure.js +12 -4
- package/lib/models/ApiKey.js +33 -25
- package/lib/models/App.js +10 -2
- package/lib/models/As2IncomingMessage.js +11 -3
- package/lib/models/As2OutgoingMessage.js +11 -3
- package/lib/models/As2Partner.js +34 -26
- package/lib/models/As2Station.js +32 -24
- package/lib/models/Auto.js +8 -0
- package/lib/models/Automation.js +51 -43
- package/lib/models/AutomationRun.js +16 -8
- package/lib/models/BandwidthSnapshot.js +10 -2
- package/lib/models/Behavior.js +46 -38
- package/lib/models/Bundle.js +51 -43
- package/lib/models/BundleDownload.js +12 -4
- package/lib/models/BundleRecipient.js +22 -14
- package/lib/models/BundleRegistration.js +12 -4
- package/lib/models/Clickwrap.js +31 -23
- package/lib/models/DnsRecord.js +10 -2
- package/lib/models/Errors.js +8 -0
- package/lib/models/ExternalEvent.js +18 -10
- package/lib/models/File.js +68 -60
- package/lib/models/FileAction.js +8 -0
- package/lib/models/FileComment.js +27 -19
- package/lib/models/FileCommentReaction.js +18 -10
- package/lib/models/FileMigration.js +11 -3
- package/lib/models/FileUploadPart.js +8 -0
- package/lib/models/Folder.js +19 -11
- package/lib/models/FormField.js +8 -0
- package/lib/models/FormFieldSet.js +27 -19
- package/lib/models/Group.js +30 -22
- package/lib/models/GroupUser.js +32 -24
- package/lib/models/History.js +42 -34
- package/lib/models/HistoryExport.js +34 -26
- package/lib/models/HistoryExportResult.js +13 -5
- package/lib/models/Image.js +8 -0
- package/lib/models/InboxRecipient.js +22 -14
- package/lib/models/InboxRegistration.js +11 -3
- package/lib/models/InboxUpload.js +12 -4
- package/lib/models/Invoice.js +13 -5
- package/lib/models/InvoiceLineItem.js +8 -0
- package/lib/models/IpAddress.js +12 -4
- package/lib/models/Lock.js +24 -16
- package/lib/models/Message.js +37 -29
- package/lib/models/MessageComment.js +29 -21
- package/lib/models/MessageCommentReaction.js +24 -16
- package/lib/models/MessageReaction.js +24 -16
- package/lib/models/Notification.js +38 -30
- package/lib/models/Payment.js +13 -5
- package/lib/models/PaymentLineItem.js +8 -0
- package/lib/models/Permission.js +23 -15
- package/lib/models/Preview.js +8 -0
- package/lib/models/Priority.js +13 -5
- package/lib/models/Project.js +25 -17
- package/lib/models/PublicIpAddress.js +8 -0
- package/lib/models/PublicKey.js +29 -21
- package/lib/models/RemoteBandwidthSnapshot.js +10 -2
- package/lib/models/RemoteServer.js +113 -105
- package/lib/models/Request.js +27 -19
- package/lib/models/Session.js +13 -5
- package/lib/models/SettingsChange.js +10 -2
- package/lib/models/Site.js +65 -57
- package/lib/models/SsoStrategy.js +17 -9
- package/lib/models/Status.js +8 -0
- package/lib/models/Style.js +20 -12
- package/lib/models/UsageDailySnapshot.js +10 -2
- package/lib/models/UsageSnapshot.js +10 -2
- package/lib/models/User.js +85 -77
- package/lib/models/UserCipherUse.js +11 -3
- package/lib/models/UserRequest.js +24 -16
- package/lib/models/WebhookTest.js +16 -8
- package/package.json +1 -1
- package/src/Api.js +4 -8
- package/src/Errors.js +222 -0
- package/src/models/AccountLineItem.js +1 -0
- package/src/models/Action.js +1 -0
- package/src/models/ActionNotificationExport.js +14 -13
- package/src/models/ActionNotificationExportResult.js +6 -5
- package/src/models/ActionWebhookFailure.js +5 -4
- package/src/models/ApiKey.js +26 -25
- package/src/models/App.js +3 -2
- package/src/models/As2IncomingMessage.js +4 -3
- package/src/models/As2OutgoingMessage.js +4 -3
- package/src/models/As2Partner.js +27 -26
- package/src/models/As2Station.js +25 -24
- package/src/models/Auto.js +1 -0
- package/src/models/Automation.js +44 -43
- package/src/models/AutomationRun.js +9 -8
- package/src/models/BandwidthSnapshot.js +3 -2
- package/src/models/Behavior.js +39 -38
- package/src/models/Bundle.js +44 -43
- package/src/models/BundleDownload.js +5 -4
- package/src/models/BundleRecipient.js +15 -14
- package/src/models/BundleRegistration.js +5 -4
- package/src/models/Clickwrap.js +24 -23
- package/src/models/DnsRecord.js +3 -2
- package/src/models/Errors.js +1 -0
- package/src/models/ExternalEvent.js +11 -10
- package/src/models/File.js +61 -60
- package/src/models/FileAction.js +1 -0
- package/src/models/FileComment.js +20 -19
- package/src/models/FileCommentReaction.js +11 -10
- package/src/models/FileMigration.js +4 -3
- package/src/models/FileUploadPart.js +1 -0
- package/src/models/Folder.js +12 -11
- package/src/models/FormField.js +1 -0
- package/src/models/FormFieldSet.js +20 -19
- package/src/models/Group.js +23 -22
- package/src/models/GroupUser.js +25 -24
- package/src/models/History.js +35 -34
- package/src/models/HistoryExport.js +27 -26
- package/src/models/HistoryExportResult.js +6 -5
- package/src/models/Image.js +1 -0
- package/src/models/InboxRecipient.js +15 -14
- package/src/models/InboxRegistration.js +4 -3
- package/src/models/InboxUpload.js +5 -4
- package/src/models/Invoice.js +6 -5
- package/src/models/InvoiceLineItem.js +1 -0
- package/src/models/IpAddress.js +5 -4
- package/src/models/Lock.js +17 -16
- package/src/models/Message.js +30 -29
- package/src/models/MessageComment.js +22 -21
- package/src/models/MessageCommentReaction.js +17 -16
- package/src/models/MessageReaction.js +17 -16
- package/src/models/Notification.js +31 -30
- package/src/models/Payment.js +6 -5
- package/src/models/PaymentLineItem.js +1 -0
- package/src/models/Permission.js +16 -15
- package/src/models/Preview.js +1 -0
- package/src/models/Priority.js +6 -5
- package/src/models/Project.js +18 -17
- package/src/models/PublicIpAddress.js +1 -0
- package/src/models/PublicKey.js +22 -21
- package/src/models/RemoteBandwidthSnapshot.js +3 -2
- package/src/models/RemoteServer.js +106 -105
- package/src/models/Request.js +20 -19
- package/src/models/Session.js +6 -5
- package/src/models/SettingsChange.js +3 -2
- package/src/models/Site.js +58 -57
- package/src/models/SsoStrategy.js +10 -9
- package/src/models/Status.js +1 -0
- package/src/models/Style.js +13 -12
- package/src/models/UsageDailySnapshot.js +3 -2
- package/src/models/UsageSnapshot.js +3 -2
- package/src/models/User.js +78 -77
- package/src/models/UserCipherUse.js +4 -3
- package/src/models/UserRequest.js +17 -16
- package/src/models/WebhookTest.js +9 -8
- package/test/src/index.js +46 -0
@@ -0,0 +1,130 @@
|
|
1
|
+
# HistoryExport
|
2
|
+
|
3
|
+
## Example HistoryExport Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"history_version": "20201213.2",
|
9
|
+
"start_at": "2000-01-01T01:00:00Z",
|
10
|
+
"end_at": "2000-01-01T01:00:00Z",
|
11
|
+
"status": "ready",
|
12
|
+
"query_action": "read",
|
13
|
+
"query_interface": "ftp",
|
14
|
+
"query_user_id": "1",
|
15
|
+
"query_file_id": "1",
|
16
|
+
"query_parent_id": "1",
|
17
|
+
"query_path": "MyFile.txt",
|
18
|
+
"query_folder": "Folder",
|
19
|
+
"query_src": "SrcFolder",
|
20
|
+
"query_destination": "DestFolder",
|
21
|
+
"query_ip": "127.0.0.1",
|
22
|
+
"query_username": "jerry",
|
23
|
+
"query_failure_type": "bad_password",
|
24
|
+
"query_target_id": "1",
|
25
|
+
"query_target_name": "full",
|
26
|
+
"query_target_permission": "full",
|
27
|
+
"query_target_user_id": "1",
|
28
|
+
"query_target_username": "jerry",
|
29
|
+
"query_target_platform": "windows",
|
30
|
+
"query_target_permission_set": "desktop_app",
|
31
|
+
"results_url": "https://files.com/history_results.csv"
|
32
|
+
}
|
33
|
+
```
|
34
|
+
|
35
|
+
* `id` (int64): History Export ID
|
36
|
+
* `history_version` (string): Version of the history for the export.
|
37
|
+
* `start_at` (date-time): Start date/time of export range.
|
38
|
+
* `end_at` (date-time): End date/time of export range.
|
39
|
+
* `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
|
40
|
+
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
41
|
+
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
|
42
|
+
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
43
|
+
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
44
|
+
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
45
|
+
* `query_path` (string): Return results that are file actions related to this path.
|
46
|
+
* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
|
47
|
+
* `query_src` (string): Return results that are file moves originating from this path.
|
48
|
+
* `query_destination` (string): Return results that are file moves with this path as destination.
|
49
|
+
* `query_ip` (string): Filter results by this IP address.
|
50
|
+
* `query_username` (string): Filter results by this username.
|
51
|
+
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
|
52
|
+
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
|
53
|
+
* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
54
|
+
* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
|
55
|
+
* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
56
|
+
* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
57
|
+
* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
58
|
+
* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
|
59
|
+
* `results_url` (string): If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.
|
60
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
61
|
+
|
62
|
+
---
|
63
|
+
|
64
|
+
## Show History Export
|
65
|
+
|
66
|
+
```
|
67
|
+
await HistoryExport.find(id)
|
68
|
+
```
|
69
|
+
|
70
|
+
|
71
|
+
### Parameters
|
72
|
+
|
73
|
+
* `id` (int64): Required - History Export ID.
|
74
|
+
|
75
|
+
---
|
76
|
+
|
77
|
+
## Create History Export
|
78
|
+
|
79
|
+
```
|
80
|
+
await HistoryExport.create({
|
81
|
+
'user_id': 1,
|
82
|
+
'start_at': "2000-01-01T01:00:00Z",
|
83
|
+
'end_at': "2000-01-01T01:00:00Z",
|
84
|
+
'query_action': "read",
|
85
|
+
'query_interface': "ftp",
|
86
|
+
'query_user_id': "1",
|
87
|
+
'query_file_id': "1",
|
88
|
+
'query_parent_id': "1",
|
89
|
+
'query_path': "MyFile.txt",
|
90
|
+
'query_folder': "Folder",
|
91
|
+
'query_src': "SrcFolder",
|
92
|
+
'query_destination': "DestFolder",
|
93
|
+
'query_ip': "127.0.0.1",
|
94
|
+
'query_username': "jerry",
|
95
|
+
'query_failure_type': "bad_password",
|
96
|
+
'query_target_id': "1",
|
97
|
+
'query_target_name': "full",
|
98
|
+
'query_target_permission': "full",
|
99
|
+
'query_target_user_id': "1",
|
100
|
+
'query_target_username': "jerry",
|
101
|
+
'query_target_platform': "windows",
|
102
|
+
'query_target_permission_set': "desktop_app",
|
103
|
+
})
|
104
|
+
```
|
105
|
+
|
106
|
+
|
107
|
+
### Parameters
|
108
|
+
|
109
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
110
|
+
* `start_at` (string): Start date/time of export range.
|
111
|
+
* `end_at` (string): End date/time of export range.
|
112
|
+
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
113
|
+
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
|
114
|
+
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
115
|
+
* `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
|
116
|
+
* `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
|
117
|
+
* `query_path` (string): Return results that are file actions related to this path.
|
118
|
+
* `query_folder` (string): Return results that are file actions related to files or folders inside this folder path.
|
119
|
+
* `query_src` (string): Return results that are file moves originating from this path.
|
120
|
+
* `query_destination` (string): Return results that are file moves with this path as destination.
|
121
|
+
* `query_ip` (string): Filter results by this IP address.
|
122
|
+
* `query_username` (string): Filter results by this username.
|
123
|
+
* `query_failure_type` (string): If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
|
124
|
+
* `query_target_id` (string): If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
|
125
|
+
* `query_target_name` (string): If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
126
|
+
* `query_target_permission` (string): If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
|
127
|
+
* `query_target_user_id` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
128
|
+
* `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
129
|
+
* `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
130
|
+
* `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
|
@@ -0,0 +1,75 @@
|
|
1
|
+
# HistoryExportResult
|
2
|
+
|
3
|
+
## Example HistoryExportResult Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"created_at": 1,
|
9
|
+
"user_id": 1,
|
10
|
+
"file_id": 1,
|
11
|
+
"parent_id": 1,
|
12
|
+
"path": "MyFile.txt",
|
13
|
+
"folder": "Folder",
|
14
|
+
"src": "SrcFolder",
|
15
|
+
"destination": "DestFolder",
|
16
|
+
"ip": "127.0.0.1",
|
17
|
+
"username": "jerry",
|
18
|
+
"action": "read",
|
19
|
+
"failure_type": "bad_password",
|
20
|
+
"interface": "ftp",
|
21
|
+
"target_id": 1,
|
22
|
+
"target_name": "full",
|
23
|
+
"target_permission": "full",
|
24
|
+
"target_recursive": true,
|
25
|
+
"target_expires_at": 1,
|
26
|
+
"target_permission_set": "desktop_app",
|
27
|
+
"target_platform": "windows",
|
28
|
+
"target_username": "jerry",
|
29
|
+
"target_user_id": 1
|
30
|
+
}
|
31
|
+
```
|
32
|
+
|
33
|
+
* `id` (int64): Action ID
|
34
|
+
* `created_at` (int64): When the action happened
|
35
|
+
* `user_id` (int64): User ID
|
36
|
+
* `file_id` (int64): File ID related to the action
|
37
|
+
* `parent_id` (int64): ID of the parent folder
|
38
|
+
* `path` (string): Path of the related action This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
39
|
+
* `folder` (string): Folder in which the action occurred
|
40
|
+
* `src` (string): File move originated from this path
|
41
|
+
* `destination` (string): File moved to this destination folder
|
42
|
+
* `ip` (string): Client IP that performed the action
|
43
|
+
* `username` (string): Username of the user that performed the action
|
44
|
+
* `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
45
|
+
* `failure_type` (string): The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
|
46
|
+
* `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
|
47
|
+
* `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
|
48
|
+
* `target_name` (string): Name of the User, Group or other object with a name related to this action
|
49
|
+
* `target_permission` (string): Permission level of the action
|
50
|
+
* `target_recursive` (boolean): Whether or not the action was recursive
|
51
|
+
* `target_expires_at` (int64): If searching for Histories about API keys, this is when the API key will expire
|
52
|
+
* `target_permission_set` (string): If searching for Histories about API keys, this represents the permission set of the associated API key
|
53
|
+
* `target_platform` (string): If searching for Histories about API keys, this is the platform on which the action was taken
|
54
|
+
* `target_username` (string): If searching for Histories about API keys, this is the username on which the action was taken
|
55
|
+
* `target_user_id` (int64): If searching for Histories about API keys, this is the User ID on which the action was taken
|
56
|
+
|
57
|
+
---
|
58
|
+
|
59
|
+
## List History Export Results
|
60
|
+
|
61
|
+
```
|
62
|
+
await HistoryExportResult.list({
|
63
|
+
'user_id': 1,
|
64
|
+
'per_page': 1,
|
65
|
+
'history_export_id': 1,
|
66
|
+
})
|
67
|
+
```
|
68
|
+
|
69
|
+
|
70
|
+
### Parameters
|
71
|
+
|
72
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
73
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
74
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
75
|
+
* `history_export_id` (int64): Required - ID of the associated history export.
|
@@ -0,0 +1,76 @@
|
|
1
|
+
# InboxRecipient
|
2
|
+
|
3
|
+
## Example InboxRecipient Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"company": "Acme Inc.",
|
8
|
+
"name": "John Doe",
|
9
|
+
"note": "Some note.",
|
10
|
+
"recipient": "john.doe@example.com",
|
11
|
+
"sent_at": "2000-01-01T01:00:00Z"
|
12
|
+
}
|
13
|
+
```
|
14
|
+
|
15
|
+
* `company` (string): The recipient's company.
|
16
|
+
* `name` (string): The recipient's name.
|
17
|
+
* `note` (string): A note sent to the recipient with the inbox.
|
18
|
+
* `recipient` (string): The recipient's email address.
|
19
|
+
* `sent_at` (date-time): When the Inbox was shared with this recipient.
|
20
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
21
|
+
* `inbox_id` (int64): Inbox to share.
|
22
|
+
* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
|
23
|
+
|
24
|
+
---
|
25
|
+
|
26
|
+
## List Inbox Recipients
|
27
|
+
|
28
|
+
```
|
29
|
+
await InboxRecipient.list({
|
30
|
+
'user_id': 1,
|
31
|
+
'per_page': 1,
|
32
|
+
'inbox_id': 1,
|
33
|
+
})
|
34
|
+
```
|
35
|
+
|
36
|
+
|
37
|
+
### Parameters
|
38
|
+
|
39
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
40
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
41
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
42
|
+
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `has_registrations`.
|
43
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
44
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
|
45
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
|
46
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
47
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
|
48
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
|
49
|
+
* `inbox_id` (int64): Required - List recipients for the inbox with this ID.
|
50
|
+
|
51
|
+
---
|
52
|
+
|
53
|
+
## Create Inbox Recipient
|
54
|
+
|
55
|
+
```
|
56
|
+
await InboxRecipient.create({
|
57
|
+
'user_id': 1,
|
58
|
+
'inbox_id': 1,
|
59
|
+
'recipient': "johndoe@gmail.com",
|
60
|
+
'name': "John Smith",
|
61
|
+
'company': "Acme Ltd",
|
62
|
+
'note': "Just a note.",
|
63
|
+
'share_after_create': true,
|
64
|
+
})
|
65
|
+
```
|
66
|
+
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
71
|
+
* `inbox_id` (int64): Required - Inbox to share.
|
72
|
+
* `recipient` (string): Required - Email address to share this inbox with.
|
73
|
+
* `name` (string): Name of recipient.
|
74
|
+
* `company` (string): Company of recipient.
|
75
|
+
* `note` (string): Note to include in email.
|
76
|
+
* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# InboxRegistration
|
2
|
+
|
3
|
+
## Example InboxRegistration Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"code": "abc123",
|
8
|
+
"name": "account",
|
9
|
+
"company": "Action Verb",
|
10
|
+
"email": "john.doe@files.com",
|
11
|
+
"clickwrap_body": "",
|
12
|
+
"form_field_set_id": 1,
|
13
|
+
"form_field_data": "",
|
14
|
+
"inbox_id": 1,
|
15
|
+
"inbox_recipient_id": 1,
|
16
|
+
"inbox_title": ""
|
17
|
+
}
|
18
|
+
```
|
19
|
+
|
20
|
+
* `code` (string): Registration cookie code
|
21
|
+
* `name` (string): Registrant name
|
22
|
+
* `company` (string): Registrant company name
|
23
|
+
* `email` (string): Registrant email address
|
24
|
+
* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
|
25
|
+
* `form_field_set_id` (int64): Id of associated form field set
|
26
|
+
* `form_field_data` (object): Data for form field set with form field ids as keys and user data as values
|
27
|
+
* `inbox_id` (int64): Id of associated inbox
|
28
|
+
* `inbox_recipient_id` (int64): Id of associated inbox recipient
|
29
|
+
* `inbox_title` (string): Title of associated inbox
|
30
|
+
|
31
|
+
---
|
32
|
+
|
33
|
+
## List Inbox Registrations
|
34
|
+
|
35
|
+
```
|
36
|
+
await InboxRegistration.list({
|
37
|
+
'per_page': 1,
|
38
|
+
'folder_behavior_id': 1,
|
39
|
+
})
|
40
|
+
```
|
41
|
+
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
46
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
47
|
+
* `folder_behavior_id` (int64): ID of the associated Inbox.
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# InboxUpload
|
2
|
+
|
3
|
+
## Example InboxUpload Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"inbox_registration": "",
|
8
|
+
"path": "a/b/test.txt",
|
9
|
+
"created_at": "2020-01-01 00:00:00"
|
10
|
+
}
|
11
|
+
```
|
12
|
+
|
13
|
+
* `inbox_registration` (InboxRegistration):
|
14
|
+
* `path` (string): Upload path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
15
|
+
* `created_at` (date-time): Upload date/time
|
16
|
+
|
17
|
+
---
|
18
|
+
|
19
|
+
## List Inbox Uploads
|
20
|
+
|
21
|
+
```
|
22
|
+
await InboxUpload.list({
|
23
|
+
'per_page': 1,
|
24
|
+
'inbox_registration_id': 1,
|
25
|
+
'inbox_id': 1,
|
26
|
+
})
|
27
|
+
```
|
28
|
+
|
29
|
+
|
30
|
+
### Parameters
|
31
|
+
|
32
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
33
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
34
|
+
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at`.
|
35
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
36
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
37
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
|
38
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
39
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
40
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
|
41
|
+
* `inbox_registration_id` (int64): InboxRegistration ID
|
42
|
+
* `inbox_id` (int64): Inbox ID
|
@@ -0,0 +1,82 @@
|
|
1
|
+
# Invoice
|
2
|
+
|
3
|
+
## Example Invoice Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"amount": 1.0,
|
9
|
+
"balance": 1.0,
|
10
|
+
"created_at": "2000-01-01T01:00:00Z",
|
11
|
+
"currency": "USD",
|
12
|
+
"download_uri": "https://url...",
|
13
|
+
"invoice_line_items": {
|
14
|
+
"amount": 1.0,
|
15
|
+
"created_at": "2000-01-01T01:00:00Z",
|
16
|
+
"description": "Service from 2019-01-01 through 2019-12-31",
|
17
|
+
"type": "invoice",
|
18
|
+
"service_end_at": "2000-01-01T01:00:00Z",
|
19
|
+
"service_start_at": "2000-01-01T01:00:00Z",
|
20
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
21
|
+
"plan": "Enterprise",
|
22
|
+
"site": "My site"
|
23
|
+
},
|
24
|
+
"method": "paypal",
|
25
|
+
"payment_line_items": {
|
26
|
+
"amount": 1.0,
|
27
|
+
"created_at": "2000-01-01T01:00:00Z",
|
28
|
+
"invoice_id": 1,
|
29
|
+
"payment_id": 1,
|
30
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
31
|
+
},
|
32
|
+
"payment_reversed_at": "2000-01-01T01:00:00Z",
|
33
|
+
"payment_type": "",
|
34
|
+
"site_name": "My Site",
|
35
|
+
"type": "invoice",
|
36
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
37
|
+
}
|
38
|
+
```
|
39
|
+
|
40
|
+
* `id` (int64): Line item Id
|
41
|
+
* `amount` (double): Line item amount
|
42
|
+
* `balance` (double): Line item balance
|
43
|
+
* `created_at` (date-time): Line item created at
|
44
|
+
* `currency` (string): Line item currency
|
45
|
+
* `download_uri` (string): Line item download uri
|
46
|
+
* `invoice_line_items` (InvoiceLineItem): Associated invoice line items
|
47
|
+
* `method` (string): Line item payment method
|
48
|
+
* `payment_line_items` (PaymentLineItem): Associated payment line items
|
49
|
+
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
50
|
+
* `payment_type` (string): Type of payment if applicable
|
51
|
+
* `site_name` (string): Site name this line item is for
|
52
|
+
* `type` (string): Type of line item, either payment or invoice
|
53
|
+
* `updated_at` (date-time): Line item updated at
|
54
|
+
|
55
|
+
---
|
56
|
+
|
57
|
+
## List Invoices
|
58
|
+
|
59
|
+
```
|
60
|
+
await Invoice.list({
|
61
|
+
'per_page': 1,
|
62
|
+
})
|
63
|
+
```
|
64
|
+
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
69
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
70
|
+
|
71
|
+
---
|
72
|
+
|
73
|
+
## Show Invoice
|
74
|
+
|
75
|
+
```
|
76
|
+
await Invoice.find(id)
|
77
|
+
```
|
78
|
+
|
79
|
+
|
80
|
+
### Parameters
|
81
|
+
|
82
|
+
* `id` (int64): Required - Invoice ID.
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# InvoiceLineItem
|
2
|
+
|
3
|
+
## Example InvoiceLineItem Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"amount": 1.0,
|
8
|
+
"created_at": "2000-01-01T01:00:00Z",
|
9
|
+
"description": "Service from 2019-01-01 through 2019-12-31",
|
10
|
+
"type": "invoice",
|
11
|
+
"service_end_at": "2000-01-01T01:00:00Z",
|
12
|
+
"service_start_at": "2000-01-01T01:00:00Z",
|
13
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
14
|
+
"plan": "Enterprise",
|
15
|
+
"site": "My site"
|
16
|
+
}
|
17
|
+
```
|
18
|
+
|
19
|
+
* `amount` (double): Invoice line item amount
|
20
|
+
* `created_at` (date-time): Invoice line item created at date/time
|
21
|
+
* `description` (string): Invoice line item description
|
22
|
+
* `type` (string): Invoice line item type
|
23
|
+
* `service_end_at` (date-time): Invoice line item service end date/time
|
24
|
+
* `service_start_at` (date-time): Invoice line item service start date/time
|
25
|
+
* `updated_at` (date-time): Invoice line item updated date/time
|
26
|
+
* `plan` (string): Plan name
|
27
|
+
* `site` (string): Site name
|
@@ -0,0 +1,51 @@
|
|
1
|
+
# IpAddress
|
2
|
+
|
3
|
+
## Example IpAddress Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": "Site",
|
8
|
+
"associated_with": "Site",
|
9
|
+
"group_id": 1,
|
10
|
+
"ip_addresses": [
|
11
|
+
"127.0.0.1"
|
12
|
+
]
|
13
|
+
}
|
14
|
+
```
|
15
|
+
|
16
|
+
* `id` (string): Unique label for list; used by Zapier and other integrations.
|
17
|
+
* `associated_with` (string): The object that this public IP address list is associated with.
|
18
|
+
* `group_id` (int64): Group ID
|
19
|
+
* `ip_addresses` (array): A list of IP addresses.
|
20
|
+
|
21
|
+
---
|
22
|
+
|
23
|
+
## List IP Addresses associated with the current site
|
24
|
+
|
25
|
+
```
|
26
|
+
await IpAddress.list({
|
27
|
+
'per_page': 1,
|
28
|
+
})
|
29
|
+
```
|
30
|
+
|
31
|
+
|
32
|
+
### Parameters
|
33
|
+
|
34
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
35
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
36
|
+
|
37
|
+
---
|
38
|
+
|
39
|
+
## List all possible public IP addresses
|
40
|
+
|
41
|
+
```
|
42
|
+
await IpAddress.getReserved({
|
43
|
+
'per_page': 1,
|
44
|
+
})
|
45
|
+
```
|
46
|
+
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
51
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
@@ -0,0 +1,92 @@
|
|
1
|
+
# Lock
|
2
|
+
|
3
|
+
## Example Lock Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"path": "locked_file",
|
8
|
+
"timeout": 43200,
|
9
|
+
"depth": "infinity",
|
10
|
+
"recursive": true,
|
11
|
+
"owner": "user",
|
12
|
+
"scope": "shared",
|
13
|
+
"exclusive": true,
|
14
|
+
"token": "17c54824e9931a4688ca032d03f6663c",
|
15
|
+
"type": "write",
|
16
|
+
"allow_access_by_any_user": true,
|
17
|
+
"user_id": 1,
|
18
|
+
"username": ""
|
19
|
+
}
|
20
|
+
```
|
21
|
+
|
22
|
+
* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
23
|
+
* `timeout` (int64): Lock timeout in seconds
|
24
|
+
* `depth` (string): DEPRECATED: Lock depth
|
25
|
+
* `recursive` (boolean): Does lock apply to subfolders?
|
26
|
+
* `owner` (string): Owner of the lock. This can be any arbitrary string.
|
27
|
+
* `scope` (string): DEPRECATED: Lock scope
|
28
|
+
* `exclusive` (boolean): Is lock exclusive?
|
29
|
+
* `token` (string): Lock token. Use to release lock.
|
30
|
+
* `type` (string): DEPRECATED: Lock type
|
31
|
+
* `allow_access_by_any_user` (boolean): Can lock be modified by users other than its creator?
|
32
|
+
* `user_id` (int64): Lock creator user ID
|
33
|
+
* `username` (string): Lock creator username
|
34
|
+
|
35
|
+
---
|
36
|
+
|
37
|
+
## List Locks by path
|
38
|
+
|
39
|
+
```
|
40
|
+
await Lock.listFor(path, {
|
41
|
+
'per_page': 1,
|
42
|
+
'include_children': true,
|
43
|
+
})
|
44
|
+
```
|
45
|
+
|
46
|
+
|
47
|
+
### Parameters
|
48
|
+
|
49
|
+
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
50
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
51
|
+
* `path` (string): Required - Path to operate on.
|
52
|
+
* `include_children` (boolean): Include locks from children objects?
|
53
|
+
|
54
|
+
---
|
55
|
+
|
56
|
+
## Create Lock
|
57
|
+
|
58
|
+
```
|
59
|
+
await Lock.create(path, {
|
60
|
+
'allow_access_by_any_user': true,
|
61
|
+
'exclusive': true,
|
62
|
+
'recursive': true,
|
63
|
+
'timeout': 1,
|
64
|
+
})
|
65
|
+
```
|
66
|
+
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
* `path` (string): Required - Path
|
71
|
+
* `allow_access_by_any_user` (boolean): Allow lock to be updated by any user?
|
72
|
+
* `exclusive` (boolean): Is lock exclusive?
|
73
|
+
* `recursive` (string): Does lock apply to subfolders?
|
74
|
+
* `timeout` (int64): Lock timeout length
|
75
|
+
|
76
|
+
---
|
77
|
+
|
78
|
+
## Delete Lock
|
79
|
+
|
80
|
+
```
|
81
|
+
const [lock] = await Lock.list()
|
82
|
+
|
83
|
+
await lock.delete({
|
84
|
+
'token': "token",
|
85
|
+
})
|
86
|
+
```
|
87
|
+
|
88
|
+
### Parameters
|
89
|
+
|
90
|
+
* `path` (string): Required - Path
|
91
|
+
* `token` (string): Required - Lock token
|
92
|
+
|