files.com 1.0.189 → 1.0.192
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 +3127 -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 +226 -196
- 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 +223 -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 +51 -50
- 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 +120 -103
- 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,82 @@
|
|
1
|
+
# Payment
|
2
|
+
|
3
|
+
## Example Payment 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 Payments
|
58
|
+
|
59
|
+
```
|
60
|
+
await Payment.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 Payment
|
74
|
+
|
75
|
+
```
|
76
|
+
await Payment.find(id)
|
77
|
+
```
|
78
|
+
|
79
|
+
|
80
|
+
### Parameters
|
81
|
+
|
82
|
+
* `id` (int64): Required - Payment ID.
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# PaymentLineItem
|
2
|
+
|
3
|
+
## Example PaymentLineItem Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"amount": 1.0,
|
8
|
+
"created_at": "2000-01-01T01:00:00Z",
|
9
|
+
"invoice_id": 1,
|
10
|
+
"payment_id": 1,
|
11
|
+
"updated_at": "2000-01-01T01:00:00Z"
|
12
|
+
}
|
13
|
+
```
|
14
|
+
|
15
|
+
* `amount` (double): Payment line item amount
|
16
|
+
* `created_at` (date-time): Payment line item created at date/time
|
17
|
+
* `invoice_id` (int64): Invoice ID
|
18
|
+
* `payment_id` (int64): Payment ID
|
19
|
+
* `updated_at` (date-time): Payment line item updated at date/time
|
@@ -0,0 +1,94 @@
|
|
1
|
+
# Permission
|
2
|
+
|
3
|
+
## Example Permission Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"path": "",
|
9
|
+
"user_id": 1,
|
10
|
+
"username": "Sser",
|
11
|
+
"group_id": 1,
|
12
|
+
"group_name": "",
|
13
|
+
"permission": "full",
|
14
|
+
"recursive": true
|
15
|
+
}
|
16
|
+
```
|
17
|
+
|
18
|
+
* `id` (int64): Permission ID
|
19
|
+
* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
20
|
+
* `user_id` (int64): User ID
|
21
|
+
* `username` (string): User's username
|
22
|
+
* `group_id` (int64): Group ID
|
23
|
+
* `group_name` (string): Group name if applicable
|
24
|
+
* `permission` (string): Permission type
|
25
|
+
* `recursive` (boolean): Does this permission apply to subfolders?
|
26
|
+
|
27
|
+
---
|
28
|
+
|
29
|
+
## List Permissions
|
30
|
+
|
31
|
+
```
|
32
|
+
await Permission.list({
|
33
|
+
'per_page': 1,
|
34
|
+
'group_id': 1,
|
35
|
+
'user_id': 1,
|
36
|
+
'include_groups': true,
|
37
|
+
})
|
38
|
+
```
|
39
|
+
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
* `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.
|
44
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
|
+
* `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 `group_id`, `path`, `user_id` or `permission`.
|
46
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
47
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
48
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
49
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
50
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
51
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
52
|
+
* `path` (string): DEPRECATED: Permission path. If provided, will scope permissions to this path. Use `filter[path]` instead.
|
53
|
+
* `group_id` (string): DEPRECATED: Group ID. If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
|
54
|
+
* `user_id` (string): DEPRECATED: User ID. If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
|
55
|
+
* `include_groups` (boolean): If searching by user or group, also include user's permissions that are inherited from its groups?
|
56
|
+
|
57
|
+
---
|
58
|
+
|
59
|
+
## Create Permission
|
60
|
+
|
61
|
+
```
|
62
|
+
await Permission.create({
|
63
|
+
'group_id': 1,
|
64
|
+
'permission': "full",
|
65
|
+
'recursive': true,
|
66
|
+
'user_id': 1,
|
67
|
+
'username': "Sser",
|
68
|
+
})
|
69
|
+
```
|
70
|
+
|
71
|
+
|
72
|
+
### Parameters
|
73
|
+
|
74
|
+
* `group_id` (int64): Group ID
|
75
|
+
* `path` (string): Folder path
|
76
|
+
* `permission` (string): Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
|
77
|
+
* `recursive` (boolean): Apply to subfolders recursively?
|
78
|
+
* `user_id` (int64): User ID. Provide `username` or `user_id`
|
79
|
+
* `username` (string): User username. Provide `username` or `user_id`
|
80
|
+
|
81
|
+
---
|
82
|
+
|
83
|
+
## Delete Permission
|
84
|
+
|
85
|
+
```
|
86
|
+
const [permission] = await Permission.list()
|
87
|
+
|
88
|
+
await permission.delete()
|
89
|
+
```
|
90
|
+
|
91
|
+
### Parameters
|
92
|
+
|
93
|
+
* `id` (int64): Required - Permission ID.
|
94
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Preview
|
2
|
+
|
3
|
+
## Example Preview Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"status": "complete",
|
9
|
+
"download_uri": "https://mysite.files.com/...",
|
10
|
+
"type": "image",
|
11
|
+
"size": "large"
|
12
|
+
}
|
13
|
+
```
|
14
|
+
|
15
|
+
* `id` (int64): Preview ID
|
16
|
+
* `status` (string): Preview status. Can be invalid, not_generated, generating, complete, or file_too_large
|
17
|
+
* `download_uri` (string): Link to download preview
|
18
|
+
* `type` (string): Preview type. Can be image, pdf, pdf_native, video, or audio
|
19
|
+
* `size` (string): Preview size
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# Priority
|
2
|
+
|
3
|
+
## Example Priority Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"path": "foo/bar",
|
8
|
+
"color": "pink"
|
9
|
+
}
|
10
|
+
```
|
11
|
+
|
12
|
+
* `path` (string): The path corresponding to the priority color This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
13
|
+
* `color` (string): The priority color
|
14
|
+
|
15
|
+
---
|
16
|
+
|
17
|
+
## List Priorities
|
18
|
+
|
19
|
+
```
|
20
|
+
await Priority.list(path, {
|
21
|
+
'per_page': 1,
|
22
|
+
})
|
23
|
+
```
|
24
|
+
|
25
|
+
|
26
|
+
### Parameters
|
27
|
+
|
28
|
+
* `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.
|
29
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
30
|
+
* `path` (string): Required - The path to query for priorities
|
@@ -0,0 +1,98 @@
|
|
1
|
+
# Project
|
2
|
+
|
3
|
+
## Example Project Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"global_access": "none"
|
9
|
+
}
|
10
|
+
```
|
11
|
+
|
12
|
+
* `id` (int64): Project ID
|
13
|
+
* `global_access` (string): Global access settings
|
14
|
+
|
15
|
+
---
|
16
|
+
|
17
|
+
## List Projects
|
18
|
+
|
19
|
+
```
|
20
|
+
await Project.list({
|
21
|
+
'per_page': 1,
|
22
|
+
})
|
23
|
+
```
|
24
|
+
|
25
|
+
|
26
|
+
### Parameters
|
27
|
+
|
28
|
+
* `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.
|
29
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
30
|
+
|
31
|
+
---
|
32
|
+
|
33
|
+
## Show Project
|
34
|
+
|
35
|
+
```
|
36
|
+
await Project.find(id)
|
37
|
+
```
|
38
|
+
|
39
|
+
|
40
|
+
### Parameters
|
41
|
+
|
42
|
+
* `id` (int64): Required - Project ID.
|
43
|
+
|
44
|
+
---
|
45
|
+
|
46
|
+
## Create Project
|
47
|
+
|
48
|
+
```
|
49
|
+
await Project.create({
|
50
|
+
'global_access': "global_access",
|
51
|
+
})
|
52
|
+
```
|
53
|
+
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
* `global_access` (string): Required - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
|
58
|
+
|
59
|
+
---
|
60
|
+
|
61
|
+
## Update Project
|
62
|
+
|
63
|
+
```
|
64
|
+
const [project] = await Project.list()
|
65
|
+
|
66
|
+
await project.update({
|
67
|
+
'global_access': "global_access",
|
68
|
+
})
|
69
|
+
```
|
70
|
+
|
71
|
+
### Parameters
|
72
|
+
|
73
|
+
* `id` (int64): Required - Project ID.
|
74
|
+
* `global_access` (string): Required - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
|
75
|
+
|
76
|
+
### Example Response
|
77
|
+
|
78
|
+
```json
|
79
|
+
{
|
80
|
+
"id": 1,
|
81
|
+
"global_access": "none"
|
82
|
+
}
|
83
|
+
```
|
84
|
+
|
85
|
+
---
|
86
|
+
|
87
|
+
## Delete Project
|
88
|
+
|
89
|
+
```
|
90
|
+
const [project] = await Project.list()
|
91
|
+
|
92
|
+
await project.delete()
|
93
|
+
```
|
94
|
+
|
95
|
+
### Parameters
|
96
|
+
|
97
|
+
* `id` (int64): Required - Project ID.
|
98
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# PublicIpAddress
|
2
|
+
|
3
|
+
## Example PublicIpAddress Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"ip_address": "1.1.1.1",
|
8
|
+
"server_name": "server-1",
|
9
|
+
"ftp_enabled": "",
|
10
|
+
"sftp_enabled": ""
|
11
|
+
}
|
12
|
+
```
|
13
|
+
|
14
|
+
* `ip_address` (string): The public IP address.
|
15
|
+
* `server_name` (string): The name of the frontend server.
|
16
|
+
* `ftp_enabled` (string):
|
17
|
+
* `sftp_enabled` (string):
|
@@ -0,0 +1,112 @@
|
|
1
|
+
# PublicKey
|
2
|
+
|
3
|
+
## Example PublicKey Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"title": "My public key",
|
9
|
+
"created_at": "2000-01-01T01:00:00Z",
|
10
|
+
"fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8"
|
11
|
+
}
|
12
|
+
```
|
13
|
+
|
14
|
+
* `id` (int64): Public key ID
|
15
|
+
* `title` (string): Public key title
|
16
|
+
* `created_at` (date-time): Public key created at date/time
|
17
|
+
* `fingerprint` (string): Public key fingerprint
|
18
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
19
|
+
* `public_key` (string): Actual contents of SSH key.
|
20
|
+
|
21
|
+
---
|
22
|
+
|
23
|
+
## List Public Keys
|
24
|
+
|
25
|
+
```
|
26
|
+
await PublicKey.list({
|
27
|
+
'user_id': 1,
|
28
|
+
'per_page': 1,
|
29
|
+
})
|
30
|
+
```
|
31
|
+
|
32
|
+
|
33
|
+
### Parameters
|
34
|
+
|
35
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
36
|
+
* `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.
|
37
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
|
+
|
39
|
+
---
|
40
|
+
|
41
|
+
## Show Public Key
|
42
|
+
|
43
|
+
```
|
44
|
+
await PublicKey.find(id)
|
45
|
+
```
|
46
|
+
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
* `id` (int64): Required - Public Key ID.
|
51
|
+
|
52
|
+
---
|
53
|
+
|
54
|
+
## Create Public Key
|
55
|
+
|
56
|
+
```
|
57
|
+
await PublicKey.create({
|
58
|
+
'user_id': 1,
|
59
|
+
'title': "My Main Key",
|
60
|
+
'public_key': "public_key",
|
61
|
+
})
|
62
|
+
```
|
63
|
+
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
|
67
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
68
|
+
* `title` (string): Required - Internal reference for key.
|
69
|
+
* `public_key` (string): Required - Actual contents of SSH key.
|
70
|
+
|
71
|
+
---
|
72
|
+
|
73
|
+
## Update Public Key
|
74
|
+
|
75
|
+
```
|
76
|
+
const [public_key] = await PublicKey.list()
|
77
|
+
|
78
|
+
await public_key.update({
|
79
|
+
'title': "My Main Key",
|
80
|
+
})
|
81
|
+
```
|
82
|
+
|
83
|
+
### Parameters
|
84
|
+
|
85
|
+
* `id` (int64): Required - Public Key ID.
|
86
|
+
* `title` (string): Required - Internal reference for key.
|
87
|
+
|
88
|
+
### Example Response
|
89
|
+
|
90
|
+
```json
|
91
|
+
{
|
92
|
+
"id": 1,
|
93
|
+
"title": "My public key",
|
94
|
+
"created_at": "2000-01-01T01:00:00Z",
|
95
|
+
"fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8"
|
96
|
+
}
|
97
|
+
```
|
98
|
+
|
99
|
+
---
|
100
|
+
|
101
|
+
## Delete Public Key
|
102
|
+
|
103
|
+
```
|
104
|
+
const [public_key] = await PublicKey.list()
|
105
|
+
|
106
|
+
await public_key.delete()
|
107
|
+
```
|
108
|
+
|
109
|
+
### Parameters
|
110
|
+
|
111
|
+
* `id` (int64): Required - Public Key ID.
|
112
|
+
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# RemoteBandwidthSnapshot
|
2
|
+
|
3
|
+
## Example RemoteBandwidthSnapshot Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"sync_bytes_received": 1.0,
|
9
|
+
"sync_bytes_sent": 1.0,
|
10
|
+
"logged_at": "2000-01-01T01:00:00Z",
|
11
|
+
"remote_server_id": 1
|
12
|
+
}
|
13
|
+
```
|
14
|
+
|
15
|
+
* `id` (int64): Site bandwidth ID
|
16
|
+
* `sync_bytes_received` (double): Site sync bandwidth report bytes received
|
17
|
+
* `sync_bytes_sent` (double): Site sync bandwidth report bytes sent
|
18
|
+
* `logged_at` (date-time): Time the site bandwidth report was logged
|
19
|
+
* `remote_server_id` (int64): ID of related Remote Server
|
20
|
+
|
21
|
+
---
|
22
|
+
|
23
|
+
## List Remote Bandwidth Snapshots
|
24
|
+
|
25
|
+
```
|
26
|
+
await RemoteBandwidthSnapshot.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
|
+
* `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 `logged_at`.
|
37
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
38
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
|
39
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `logged_at`.
|
40
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
41
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
42
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `logged_at`.
|