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,139 @@
|
|
1
|
+
# SsoStrategy
|
2
|
+
|
3
|
+
## Example SsoStrategy Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"protocol": "oauth2",
|
8
|
+
"provider": "okta",
|
9
|
+
"label": "My Corporate SSO Provider",
|
10
|
+
"logo_url": "https://mysite.files.com/.../logo.png",
|
11
|
+
"id": 1,
|
12
|
+
"saml_provider_cert_fingerprint": "",
|
13
|
+
"saml_provider_issuer_url": "",
|
14
|
+
"saml_provider_metadata_content": "",
|
15
|
+
"saml_provider_metadata_url": "",
|
16
|
+
"saml_provider_slo_target_url": "",
|
17
|
+
"saml_provider_sso_target_url": "",
|
18
|
+
"scim_authentication_method": "",
|
19
|
+
"scim_username": "",
|
20
|
+
"scim_oauth_access_token": "",
|
21
|
+
"scim_oauth_access_token_expires_at": "",
|
22
|
+
"subdomain": "my-site",
|
23
|
+
"provision_users": true,
|
24
|
+
"provision_groups": true,
|
25
|
+
"deprovision_users": true,
|
26
|
+
"deprovision_groups": true,
|
27
|
+
"deprovision_behavior": "disable",
|
28
|
+
"provision_group_default": "Employees",
|
29
|
+
"provision_group_exclusion": "Employees",
|
30
|
+
"provision_group_inclusion": "Employees",
|
31
|
+
"provision_group_required": "",
|
32
|
+
"provision_email_signup_groups": "Employees",
|
33
|
+
"provision_site_admin_groups": "Employees",
|
34
|
+
"provision_attachments_permission": true,
|
35
|
+
"provision_dav_permission": true,
|
36
|
+
"provision_ftp_permission": true,
|
37
|
+
"provision_sftp_permission": true,
|
38
|
+
"provision_time_zone": "Eastern Time (US & Canada)",
|
39
|
+
"provision_company": "ACME Corp.",
|
40
|
+
"ldap_base_dn": "",
|
41
|
+
"ldap_domain": "mysite.com",
|
42
|
+
"enabled": true,
|
43
|
+
"ldap_host": "ldap.site.com",
|
44
|
+
"ldap_host_2": "ldap2.site.com",
|
45
|
+
"ldap_host_3": "ldap3.site.com",
|
46
|
+
"ldap_port": 1,
|
47
|
+
"ldap_secure": true,
|
48
|
+
"ldap_username": "[ldap username]",
|
49
|
+
"ldap_username_field": "sAMAccountName"
|
50
|
+
}
|
51
|
+
```
|
52
|
+
|
53
|
+
* `protocol` (string): SSO Protocol
|
54
|
+
* `provider` (string): Provider name
|
55
|
+
* `label` (string): Custom label for the SSO provider on the login page.
|
56
|
+
* `logo_url` (string): URL holding a custom logo for the SSO provider on the login page.
|
57
|
+
* `id` (int64): ID
|
58
|
+
* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
59
|
+
* `saml_provider_issuer_url` (string): Identity provider issuer url
|
60
|
+
* `saml_provider_metadata_content` (string): Custom identity provider metadata
|
61
|
+
* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
|
62
|
+
* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
|
63
|
+
* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
64
|
+
* `scim_authentication_method` (string): SCIM authentication type.
|
65
|
+
* `scim_username` (string): SCIM username.
|
66
|
+
* `scim_oauth_access_token` (string): SCIM OAuth Access Token.
|
67
|
+
* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
|
68
|
+
* `subdomain` (string): Subdomain
|
69
|
+
* `provision_users` (boolean): Auto-provision users?
|
70
|
+
* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
|
71
|
+
* `deprovision_users` (boolean): Auto-deprovision users?
|
72
|
+
* `deprovision_groups` (boolean): Auto-deprovision group membership based on group memberships on the SSO side?
|
73
|
+
* `deprovision_behavior` (string): Method used for deprovisioning users.
|
74
|
+
* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
75
|
+
* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
76
|
+
* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
77
|
+
* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
78
|
+
* `provision_email_signup_groups` (string): Comma-separated list of group names whose members will be created with email_signup authentication.
|
79
|
+
* `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
|
80
|
+
* `provision_attachments_permission` (boolean): DEPRECATED: Auto-provisioned users get Sharing permission. Use a Group with the Bundle permission instead.
|
81
|
+
* `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
|
82
|
+
* `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
|
83
|
+
* `provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
|
84
|
+
* `provision_time_zone` (string): Default time zone for auto provisioned users.
|
85
|
+
* `provision_company` (string): Default company for auto provisioned users.
|
86
|
+
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
87
|
+
* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
|
88
|
+
* `enabled` (boolean): Is strategy enabled? This may become automatically set to `false` after a high number and duration of failures.
|
89
|
+
* `ldap_host` (string): LDAP host
|
90
|
+
* `ldap_host_2` (string): LDAP backup host
|
91
|
+
* `ldap_host_3` (string): LDAP backup host
|
92
|
+
* `ldap_port` (int64): LDAP port
|
93
|
+
* `ldap_secure` (boolean): Use secure LDAP?
|
94
|
+
* `ldap_username` (string): Username for signing in to LDAP server.
|
95
|
+
* `ldap_username_field` (string): LDAP username field
|
96
|
+
|
97
|
+
---
|
98
|
+
|
99
|
+
## List Sso Strategies
|
100
|
+
|
101
|
+
```
|
102
|
+
await SsoStrategy.list({
|
103
|
+
'per_page': 1,
|
104
|
+
})
|
105
|
+
```
|
106
|
+
|
107
|
+
|
108
|
+
### Parameters
|
109
|
+
|
110
|
+
* `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.
|
111
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
112
|
+
|
113
|
+
---
|
114
|
+
|
115
|
+
## Show Sso Strategy
|
116
|
+
|
117
|
+
```
|
118
|
+
await SsoStrategy.find(id)
|
119
|
+
```
|
120
|
+
|
121
|
+
|
122
|
+
### Parameters
|
123
|
+
|
124
|
+
* `id` (int64): Required - Sso Strategy ID.
|
125
|
+
|
126
|
+
---
|
127
|
+
|
128
|
+
## Synchronize provisioning data with the SSO remote server
|
129
|
+
|
130
|
+
```
|
131
|
+
const [sso_strategy] = await SsoStrategy.list()
|
132
|
+
|
133
|
+
await sso_strategy.sync()
|
134
|
+
```
|
135
|
+
|
136
|
+
### Parameters
|
137
|
+
|
138
|
+
* `id` (int64): Required - Sso Strategy ID.
|
139
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# Status
|
2
|
+
|
3
|
+
## Example Status Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"code": 200,
|
8
|
+
"message": "",
|
9
|
+
"status": "",
|
10
|
+
"data": "",
|
11
|
+
"errors": {
|
12
|
+
"fields": [
|
13
|
+
|
14
|
+
],
|
15
|
+
"messages": [
|
16
|
+
|
17
|
+
]
|
18
|
+
},
|
19
|
+
"clickwrap_id": 1,
|
20
|
+
"clickwrap_body": ""
|
21
|
+
}
|
22
|
+
```
|
23
|
+
|
24
|
+
* `code` (int64): Status HTTP code
|
25
|
+
* `message` (string): Error message
|
26
|
+
* `status` (string): Status message
|
27
|
+
* `data` (Auto): Additional data
|
28
|
+
* `errors` (Errors): A list of api errors
|
29
|
+
* `clickwrap_id` (int64): Required Clickwrap id
|
30
|
+
* `clickwrap_body` (string): Required Clickwrap body
|
@@ -0,0 +1,76 @@
|
|
1
|
+
# Style
|
2
|
+
|
3
|
+
## Example Style Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"path": "",
|
9
|
+
"logo": "https://mysite.files.com/...",
|
10
|
+
"thumbnail": ""
|
11
|
+
}
|
12
|
+
```
|
13
|
+
|
14
|
+
* `id` (int64): Style ID
|
15
|
+
* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
16
|
+
* `logo` (Image): Logo
|
17
|
+
* `thumbnail` (Image): Logo thumbnail
|
18
|
+
* `file` (file): Logo for custom branding.
|
19
|
+
|
20
|
+
---
|
21
|
+
|
22
|
+
## Show Style
|
23
|
+
|
24
|
+
```
|
25
|
+
await Style.find(path)
|
26
|
+
```
|
27
|
+
|
28
|
+
|
29
|
+
### Parameters
|
30
|
+
|
31
|
+
* `path` (string): Required - Style path.
|
32
|
+
|
33
|
+
---
|
34
|
+
|
35
|
+
## Update Style
|
36
|
+
|
37
|
+
```
|
38
|
+
const style = new Style()
|
39
|
+
style.path = myFilePath
|
40
|
+
|
41
|
+
await style.update({
|
42
|
+
'file': "file",
|
43
|
+
})
|
44
|
+
```
|
45
|
+
|
46
|
+
### Parameters
|
47
|
+
|
48
|
+
* `path` (string): Required - Style path.
|
49
|
+
* `file` (file): Required - Logo for custom branding.
|
50
|
+
|
51
|
+
### Example Response
|
52
|
+
|
53
|
+
```json
|
54
|
+
{
|
55
|
+
"id": 1,
|
56
|
+
"path": "",
|
57
|
+
"logo": "https://mysite.files.com/...",
|
58
|
+
"thumbnail": ""
|
59
|
+
}
|
60
|
+
```
|
61
|
+
|
62
|
+
---
|
63
|
+
|
64
|
+
## Delete Style
|
65
|
+
|
66
|
+
```
|
67
|
+
const style = new Style()
|
68
|
+
style.path = myFilePath
|
69
|
+
|
70
|
+
await style.delete()
|
71
|
+
```
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
* `path` (string): Required - Style path.
|
76
|
+
|
@@ -0,0 +1,56 @@
|
|
1
|
+
# UsageDailySnapshot
|
2
|
+
|
3
|
+
## Example UsageDailySnapshot Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"date": "2020-11-21",
|
9
|
+
"api_usage_available": true,
|
10
|
+
"read_api_usage": "100",
|
11
|
+
"write_api_usage": "50",
|
12
|
+
"user_count": "25",
|
13
|
+
"current_storage": "65536",
|
14
|
+
"deleted_files_storage": "65536",
|
15
|
+
"deleted_files_counted_in_minimum": "65536",
|
16
|
+
"root_storage": "65536",
|
17
|
+
"usage_by_top_level_dir": [
|
18
|
+
|
19
|
+
]
|
20
|
+
}
|
21
|
+
```
|
22
|
+
|
23
|
+
* `id` (int64): ID of the usage record
|
24
|
+
* `date` (date): The date of this usage record
|
25
|
+
* `api_usage_available` (boolean): True if the API usage fields `read_api_usage` and `write_api_usage` can be relied upon. If this is false, we suggest hiding that value from any UI.
|
26
|
+
* `read_api_usage` (int64): Read API Calls used on this day. Note: only updated for days before the current day.
|
27
|
+
* `write_api_usage` (int64): Write API Calls used on this day. Note: only updated for days before the current day.
|
28
|
+
* `user_count` (int64): Number of billable users as of this day.
|
29
|
+
* `current_storage` (int64): GB of Files Native Storage used on this day.
|
30
|
+
* `deleted_files_storage` (int64): GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
|
31
|
+
* `deleted_files_counted_in_minimum` (int64): GB of Files Native Storage used on this day for files that have been permanently deleted but were uploaded less than 30 days ago, and are still billable.
|
32
|
+
* `root_storage` (int64): GB of Files Native Storage used for the root folder. Included here because this value will not be part of `usage_by_top_level_dir`
|
33
|
+
* `usage_by_top_level_dir` (array): Usage broken down by each top-level folder
|
34
|
+
|
35
|
+
---
|
36
|
+
|
37
|
+
## List Usage Daily Snapshots
|
38
|
+
|
39
|
+
```
|
40
|
+
await UsageDailySnapshot.list({
|
41
|
+
'per_page': 1,
|
42
|
+
})
|
43
|
+
```
|
44
|
+
|
45
|
+
|
46
|
+
### Parameters
|
47
|
+
|
48
|
+
* `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.
|
49
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
50
|
+
* `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 `date` and `usage_snapshot_id`.
|
51
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
52
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
53
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
54
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
55
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
56
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# UsageSnapshot
|
2
|
+
|
3
|
+
## Example UsageSnapshot Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"start_at": "2000-01-01T01:00:00Z",
|
9
|
+
"end_at": "2000-01-01T01:00:00Z",
|
10
|
+
"created_at": "2000-01-01T01:00:00Z",
|
11
|
+
"high_water_user_count": 1.0,
|
12
|
+
"current_storage": 1.0,
|
13
|
+
"high_water_storage": 1.0,
|
14
|
+
"total_downloads": 1,
|
15
|
+
"total_uploads": 1,
|
16
|
+
"updated_at": "2000-01-01T01:00:00Z",
|
17
|
+
"usage_by_top_level_dir": "",
|
18
|
+
"root_storage": 1.0,
|
19
|
+
"deleted_files_counted_in_minimum": 1.0,
|
20
|
+
"deleted_files_storage": 1.0,
|
21
|
+
"total_billable_usage": 1.0,
|
22
|
+
"total_billable_transfer_usage": 1.0,
|
23
|
+
"bytes_sent": 1.0,
|
24
|
+
"sync_bytes_received": 1.0,
|
25
|
+
"sync_bytes_sent": 1.0
|
26
|
+
}
|
27
|
+
```
|
28
|
+
|
29
|
+
* `id` (int64): Usage snapshot ID
|
30
|
+
* `start_at` (date-time): Usage snapshot start date/time
|
31
|
+
* `end_at` (date-time): Usage snapshot end date/time
|
32
|
+
* `created_at` (date-time): DEPRECATED: Usage snapshot created at date/time
|
33
|
+
* `high_water_user_count` (double): Highest user count number in time period
|
34
|
+
* `current_storage` (double): Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)
|
35
|
+
* `high_water_storage` (double): Highest Storage Usage GB recorded in time period (used for billing)
|
36
|
+
* `total_downloads` (int64): DEPRECATED: Number of downloads in report time period
|
37
|
+
* `total_uploads` (int64): DEPRECATED: Number of uploads in time period
|
38
|
+
* `updated_at` (date-time): DEPRECATED: The last time this site usage report was updated
|
39
|
+
* `usage_by_top_level_dir` (object): Storage Usage - map of root folders to their usage as of end date (not necessarily high water mark, which is used for billing)
|
40
|
+
* `root_storage` (double): Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)
|
41
|
+
* `deleted_files_counted_in_minimum` (double): Storage Usage for files that are deleted but uploaded within last 30 days as of end date (not necessarily high water mark, which is used for billing)
|
42
|
+
* `deleted_files_storage` (double): Storage Usage for files that are deleted but retained as backups as of end date (not necessarily high water mark, which is used for billing)
|
43
|
+
* `total_billable_usage` (double): Storage + Transfer Usage - Total Billable amount
|
44
|
+
* `total_billable_transfer_usage` (double): Transfer usage for period - Total Billable amount
|
45
|
+
* `bytes_sent` (double): Transfer Usage for period - Outbound GB from Files Native Storage
|
46
|
+
* `sync_bytes_received` (double): Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)
|
47
|
+
* `sync_bytes_sent` (double): Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)
|
48
|
+
|
49
|
+
---
|
50
|
+
|
51
|
+
## List Usage Snapshots
|
52
|
+
|
53
|
+
```
|
54
|
+
await UsageSnapshot.list({
|
55
|
+
'per_page': 1,
|
56
|
+
})
|
57
|
+
```
|
58
|
+
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
* `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.
|
63
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|