files.com 1.0.190 → 1.0.193

package/docs/models/SsoStrategy.md

@@ -0,0 +1,139 @@
+# SsoStrategy
+
+## Example SsoStrategy Object
+
+```
+{
+  "protocol": "oauth2",
+  "provider": "okta",
+  "label": "My Corporate SSO Provider",
+  "logo_url": "https://mysite.files.com/.../logo.png",
+  "id": 1,
+  "saml_provider_cert_fingerprint": "",
+  "saml_provider_issuer_url": "",
+  "saml_provider_metadata_content": "",
+  "saml_provider_metadata_url": "",
+  "saml_provider_slo_target_url": "",
+  "saml_provider_sso_target_url": "",
+  "scim_authentication_method": "",
+  "scim_username": "",
+  "scim_oauth_access_token": "",
+  "scim_oauth_access_token_expires_at": "",
+  "subdomain": "my-site",
+  "provision_users": true,
+  "provision_groups": true,
+  "deprovision_users": true,
+  "deprovision_groups": true,
+  "deprovision_behavior": "disable",
+  "provision_group_default": "Employees",
+  "provision_group_exclusion": "Employees",
+  "provision_group_inclusion": "Employees",
+  "provision_group_required": "",
+  "provision_email_signup_groups": "Employees",
+  "provision_site_admin_groups": "Employees",
+  "provision_attachments_permission": true,
+  "provision_dav_permission": true,
+  "provision_ftp_permission": true,
+  "provision_sftp_permission": true,
+  "provision_time_zone": "Eastern Time (US & Canada)",
+  "provision_company": "ACME Corp.",
+  "ldap_base_dn": "",
+  "ldap_domain": "mysite.com",
+  "enabled": true,
+  "ldap_host": "ldap.site.com",
+  "ldap_host_2": "ldap2.site.com",
+  "ldap_host_3": "ldap3.site.com",
+  "ldap_port": 1,
+  "ldap_secure": true,
+  "ldap_username": "[ldap username]",
+  "ldap_username_field": "sAMAccountName"
+}
+```
+
+* `protocol` (string): SSO Protocol
+* `provider` (string): Provider name
+* `label` (string): Custom label for the SSO provider on the login page.
+* `logo_url` (string): URL holding a custom logo for the SSO provider on the login page.
+* `id` (int64): ID
+* `saml_provider_cert_fingerprint` (string): Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
+* `saml_provider_issuer_url` (string): Identity provider issuer url
+* `saml_provider_metadata_content` (string): Custom identity provider metadata
+* `saml_provider_metadata_url` (string): Metadata URL for the SAML identity provider
+* `saml_provider_slo_target_url` (string): Identity provider SLO endpoint
+* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
+* `scim_authentication_method` (string): SCIM authentication type.
+* `scim_username` (string): SCIM username.
+* `scim_oauth_access_token` (string): SCIM OAuth Access Token.
+* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
+* `subdomain` (string): Subdomain
+* `provision_users` (boolean): Auto-provision users?
+* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
+* `deprovision_users` (boolean): Auto-deprovision users?
+* `deprovision_groups` (boolean): Auto-deprovision group membership based on group memberships on the SSO side?
+* `deprovision_behavior` (string): Method used for deprovisioning users.
+* `provision_group_default` (string): Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
+* `provision_group_exclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
+* `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
+* `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
+* `provision_email_signup_groups` (string): Comma-separated list of group names whose members will be created with email_signup authentication.
+* `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
+* `provision_attachments_permission` (boolean): DEPRECATED: Auto-provisioned users get Sharing permission. Use a Group with the Bundle permission instead.
+* `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
+* `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
+* `provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
+* `provision_time_zone` (string): Default time zone for auto provisioned users.
+* `provision_company` (string): Default company for auto provisioned users.
+* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
+* `ldap_domain` (string): Domain name that will be appended to LDAP usernames
+* `enabled` (boolean): Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
+* `ldap_host` (string): LDAP host
+* `ldap_host_2` (string): LDAP backup host
+* `ldap_host_3` (string): LDAP backup host
+* `ldap_port` (int64): LDAP port
+* `ldap_secure` (boolean): Use secure LDAP?
+* `ldap_username` (string): Username for signing in to LDAP server.
+* `ldap_username_field` (string): LDAP username field
+
+---
+
+## List Sso Strategies
+
+```
+await SsoStrategy.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+
+---
+
+## Show Sso Strategy
+
+```
+await SsoStrategy.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Sso Strategy ID.
+
+---
+
+## Synchronize provisioning data with the SSO remote server
+
+```
+const [sso_strategy] = await SsoStrategy.list()
+
+await sso_strategy.sync()
+```
+
+### Parameters
+
+* `id` (int64): Required - Sso Strategy ID.
+

package/docs/models/Status.md

@@ -0,0 +1,30 @@
+# Status
+
+## Example Status Object
+
+```
+{
+  "code": 200,
+  "message": "",
+  "status": "",
+  "data": "",
+  "errors": {
+    "fields": [
+
+    ],
+    "messages": [
+
+    ]
+  },
+  "clickwrap_id": 1,
+  "clickwrap_body": ""
+}
+```
+
+* `code` (int64): Status HTTP code
+* `message` (string): Error message
+* `status` (string): Status message
+* `data` (Auto): Additional data
+* `errors` (Errors): A list of api errors
+* `clickwrap_id` (int64): Required Clickwrap id
+* `clickwrap_body` (string): Required Clickwrap body

package/docs/models/Style.md

@@ -0,0 +1,76 @@
+# Style
+
+## Example Style Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "logo": "https://mysite.files.com/...",
+  "thumbnail": ""
+}
+```
+
+* `id` (int64): Style ID
+* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `logo` (Image): Logo
+* `thumbnail` (Image): Logo thumbnail
+* `file` (file): Logo for custom branding.
+
+---
+
+## Show Style
+
+```
+await Style.find(path)
+```
+
+
+### Parameters
+
+* `path` (string): Required - Style path.
+
+---
+
+## Update Style
+
+```
+const style = new Style()
+style.path = myFilePath
+
+await style.update({
+  'file': "file",
+})
+```
+
+### Parameters
+
+* `path` (string): Required - Style path.
+* `file` (file): Required - Logo for custom branding.
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "path": "",
+  "logo": "https://mysite.files.com/...",
+  "thumbnail": ""
+}
+```
+
+---
+
+## Delete Style
+
+```
+const style = new Style()
+style.path = myFilePath
+
+await style.delete()
+```
+
+### Parameters
+
+* `path` (string): Required - Style path.
+

package/docs/models/UsageDailySnapshot.md

@@ -0,0 +1,56 @@
+# UsageDailySnapshot
+
+## Example UsageDailySnapshot Object
+
+```
+{
+  "id": 1,
+  "date": "2020-11-21",
+  "api_usage_available": true,
+  "read_api_usage": "100",
+  "write_api_usage": "50",
+  "user_count": "25",
+  "current_storage": "65536",
+  "deleted_files_storage": "65536",
+  "deleted_files_counted_in_minimum": "65536",
+  "root_storage": "65536",
+  "usage_by_top_level_dir": [
+
+  ]
+}
+```
+
+* `id` (int64): ID of the usage record
+* `date` (date): The date of this usage record
+* `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.
+* `read_api_usage` (int64): Read API Calls used on this day. Note: only updated for days before the current day.
+* `write_api_usage` (int64): Write API Calls used on this day. Note: only updated for days before the current day.
+* `user_count` (int64): Number of billable users as of this day.
+* `current_storage` (int64): GB of Files Native Storage used on this day.
+* `deleted_files_storage` (int64): GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
+* `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.
+* `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`
+* `usage_by_top_level_dir` (array): Usage broken down by each top-level folder
+
+---
+
+## List Usage Daily Snapshots
+
+```
+await UsageDailySnapshot.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `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`.
+* `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 ]`.
+* `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 ]`.
+* `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 ]`.
+* `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 ]`.
+* `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 ]`.
+* `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 ]`.

package/docs/models/UsageSnapshot.md

@@ -0,0 +1,63 @@
+# UsageSnapshot
+
+## Example UsageSnapshot Object
+
+```
+{
+  "id": 1,
+  "start_at": "2000-01-01T01:00:00Z",
+  "end_at": "2000-01-01T01:00:00Z",
+  "created_at": "2000-01-01T01:00:00Z",
+  "high_water_user_count": 1.0,
+  "current_storage": 1.0,
+  "high_water_storage": 1.0,
+  "total_downloads": 1,
+  "total_uploads": 1,
+  "updated_at": "2000-01-01T01:00:00Z",
+  "usage_by_top_level_dir": "",
+  "root_storage": 1.0,
+  "deleted_files_counted_in_minimum": 1.0,
+  "deleted_files_storage": 1.0,
+  "total_billable_usage": 1.0,
+  "total_billable_transfer_usage": 1.0,
+  "bytes_sent": 1.0,
+  "sync_bytes_received": 1.0,
+  "sync_bytes_sent": 1.0
+}
+```
+
+* `id` (int64): Usage snapshot ID
+* `start_at` (date-time): Usage snapshot start date/time
+* `end_at` (date-time): Usage snapshot end date/time
+* `created_at` (date-time): DEPRECATED: Usage snapshot created at date/time
+* `high_water_user_count` (double): Highest user count number in time period
+* `current_storage` (double): Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)
+* `high_water_storage` (double): Highest Storage Usage GB recorded in time period (used for billing)
+* `total_downloads` (int64): DEPRECATED: Number of downloads in report time period
+* `total_uploads` (int64): DEPRECATED: Number of uploads in time period
+* `updated_at` (date-time): DEPRECATED: The last time this site usage report was updated
+* `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)
+* `root_storage` (double): Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)
+* `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)
+* `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)
+* `total_billable_usage` (double): Storage + Transfer Usage - Total Billable amount
+* `total_billable_transfer_usage` (double): Transfer usage for period - Total Billable amount
+* `bytes_sent` (double): Transfer Usage for period - Outbound GB from Files Native Storage
+* `sync_bytes_received` (double): Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)
+* `sync_bytes_sent` (double): Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)
+
+---
+
+## List Usage Snapshots
+
+```
+await UsageSnapshot.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).