files.com 1.0.248 → 1.0.249

package/lib/models/SsoStrategy.js

@@ -31,135 +31,179 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // string # SSO Protocol
   (0, _defineProperty2.default)(this, "getProtocol", function () {
     return _this.attributes.protocol;
   });
+  // string # Provider name
   (0, _defineProperty2.default)(this, "getProvider", function () {
     return _this.attributes.provider;
   });
+  // string # Custom label for the SSO provider on the login page.
   (0, _defineProperty2.default)(this, "getLabel", function () {
     return _this.attributes.label;
   });
+  // string # URL holding a custom logo for the SSO provider on the login page.
   (0, _defineProperty2.default)(this, "getLogoUrl", function () {
     return _this.attributes.logo_url;
   });
+  // int64 # ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
+  // string # Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
   (0, _defineProperty2.default)(this, "getSamlProviderCertFingerprint", function () {
     return _this.attributes.saml_provider_cert_fingerprint;
   });
+  // string # Identity provider issuer url
   (0, _defineProperty2.default)(this, "getSamlProviderIssuerUrl", function () {
     return _this.attributes.saml_provider_issuer_url;
   });
+  // string # Custom identity provider metadata
   (0, _defineProperty2.default)(this, "getSamlProviderMetadataContent", function () {
     return _this.attributes.saml_provider_metadata_content;
   });
+  // string # Metadata URL for the SAML identity provider
   (0, _defineProperty2.default)(this, "getSamlProviderMetadataUrl", function () {
     return _this.attributes.saml_provider_metadata_url;
   });
+  // string # Identity provider SLO endpoint
   (0, _defineProperty2.default)(this, "getSamlProviderSloTargetUrl", function () {
     return _this.attributes.saml_provider_slo_target_url;
   });
+  // string # Identity provider SSO endpoint if saml_provider_metadata_url is not available.
   (0, _defineProperty2.default)(this, "getSamlProviderSsoTargetUrl", function () {
     return _this.attributes.saml_provider_sso_target_url;
   });
+  // string # SCIM authentication type.
   (0, _defineProperty2.default)(this, "getScimAuthenticationMethod", function () {
     return _this.attributes.scim_authentication_method;
   });
+  // string # SCIM username.
   (0, _defineProperty2.default)(this, "getScimUsername", function () {
     return _this.attributes.scim_username;
   });
+  // string # SCIM OAuth Access Token.
   (0, _defineProperty2.default)(this, "getScimOauthAccessToken", function () {
     return _this.attributes.scim_oauth_access_token;
   });
+  // string # SCIM OAuth Access Token Expiration Time.
   (0, _defineProperty2.default)(this, "getScimOauthAccessTokenExpiresAt", function () {
     return _this.attributes.scim_oauth_access_token_expires_at;
   });
+  // string # Subdomain
   (0, _defineProperty2.default)(this, "getSubdomain", function () {
     return _this.attributes.subdomain;
   });
+  // boolean # Auto-provision users?
   (0, _defineProperty2.default)(this, "getProvisionUsers", function () {
     return _this.attributes.provision_users;
   });
+  // boolean # Auto-provision group membership based on group memberships on the SSO side?
   (0, _defineProperty2.default)(this, "getProvisionGroups", function () {
     return _this.attributes.provision_groups;
   });
+  // boolean # Auto-deprovision users?
   (0, _defineProperty2.default)(this, "getDeprovisionUsers", function () {
     return _this.attributes.deprovision_users;
   });
+  // boolean # Auto-deprovision group membership based on group memberships on the SSO side?
   (0, _defineProperty2.default)(this, "getDeprovisionGroups", function () {
     return _this.attributes.deprovision_groups;
   });
+  // string # Method used for deprovisioning users.
   (0, _defineProperty2.default)(this, "getDeprovisionBehavior", function () {
     return _this.attributes.deprovision_behavior;
   });
+  // string # Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
   (0, _defineProperty2.default)(this, "getProvisionGroupDefault", function () {
     return _this.attributes.provision_group_default;
   });
+  // string # Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
   (0, _defineProperty2.default)(this, "getProvisionGroupExclusion", function () {
     return _this.attributes.provision_group_exclusion;
   });
+  // string # Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
   (0, _defineProperty2.default)(this, "getProvisionGroupInclusion", function () {
     return _this.attributes.provision_group_inclusion;
   });
+  // string # Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
   (0, _defineProperty2.default)(this, "getProvisionGroupRequired", function () {
     return _this.attributes.provision_group_required;
   });
+  // string # Comma-separated list of group names whose members will be created with email_signup authentication.
   (0, _defineProperty2.default)(this, "getProvisionEmailSignupGroups", function () {
     return _this.attributes.provision_email_signup_groups;
   });
+  // string # Comma-separated list of group names whose members will be created as Site Admins.
   (0, _defineProperty2.default)(this, "getProvisionSiteAdminGroups", function () {
     return _this.attributes.provision_site_admin_groups;
   });
+  // boolean # DEPRECATED: Auto-provisioned users get Sharing permission. Use a Group with the Bundle permission instead.
   (0, _defineProperty2.default)(this, "getProvisionAttachmentsPermission", function () {
     return _this.attributes.provision_attachments_permission;
   });
+  // boolean # Auto-provisioned users get WebDAV permission?
   (0, _defineProperty2.default)(this, "getProvisionDavPermission", function () {
     return _this.attributes.provision_dav_permission;
   });
+  // boolean # Auto-provisioned users get FTP permission?
   (0, _defineProperty2.default)(this, "getProvisionFtpPermission", function () {
     return _this.attributes.provision_ftp_permission;
   });
+  // boolean # Auto-provisioned users get SFTP permission?
   (0, _defineProperty2.default)(this, "getProvisionSftpPermission", function () {
     return _this.attributes.provision_sftp_permission;
   });
+  // string # Default time zone for auto provisioned users.
   (0, _defineProperty2.default)(this, "getProvisionTimeZone", function () {
     return _this.attributes.provision_time_zone;
   });
+  // string # Default company for auto provisioned users.
   (0, _defineProperty2.default)(this, "getProvisionCompany", function () {
     return _this.attributes.provision_company;
   });
+  // string # Base DN for looking up users in LDAP server
   (0, _defineProperty2.default)(this, "getLdapBaseDn", function () {
     return _this.attributes.ldap_base_dn;
   });
+  // string # Domain name that will be appended to LDAP usernames
   (0, _defineProperty2.default)(this, "getLdapDomain", function () {
     return _this.attributes.ldap_domain;
   });
+  // boolean # Is strategy enabled?  This may become automatically set to `false` after a high number and duration of failures.
   (0, _defineProperty2.default)(this, "getEnabled", function () {
     return _this.attributes.enabled;
   });
+  // string # LDAP host
   (0, _defineProperty2.default)(this, "getLdapHost", function () {
     return _this.attributes.ldap_host;
   });
+  // string # LDAP backup host
   (0, _defineProperty2.default)(this, "getLdapHost2", function () {
     return _this.attributes.ldap_host_2;
   });
+  // string # LDAP backup host
   (0, _defineProperty2.default)(this, "getLdapHost3", function () {
     return _this.attributes.ldap_host_3;
   });
+  // int64 # LDAP port
   (0, _defineProperty2.default)(this, "getLdapPort", function () {
     return _this.attributes.ldap_port;
   });
+  // boolean # Use secure LDAP?
   (0, _defineProperty2.default)(this, "getLdapSecure", function () {
     return _this.attributes.ldap_secure;
   });
+  // string # Username for signing in to LDAP server.
   (0, _defineProperty2.default)(this, "getLdapUsername", function () {
     return _this.attributes.ldap_username;
   });
+  // string # LDAP username field
   (0, _defineProperty2.default)(this, "getLdapUsernameField", function () {
     return _this.attributes.ldap_username_field;
   });
+  // Synchronize provisioning data with the SSO remote server
   (0, _defineProperty2.default)(this, "sync", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
       response,
@@ -225,6 +269,9 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
   });
   this.options = _objectSpread({}, options);
 });
+// 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).
 (0, _defineProperty2.default)(SsoStrategy, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
   var _response$data;
   var params,
@@ -266,6 +313,8 @@ var SsoStrategy = /*#__PURE__*/(0, _createClass2.default)(function SsoStrategy()
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   return SsoStrategy.list(params, options);
 });
+// Parameters:
+//   id (required) - int64 - Sso Strategy ID.
 (0, _defineProperty2.default)(SsoStrategy, "find", /*#__PURE__*/function () {
   var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(id) {
     var params,

package/lib/models/Status.js

@@ -29,24 +29,31 @@ var Status = /*#__PURE__*/(0, _createClass2.default)(function Status() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # Status HTTP code
   (0, _defineProperty2.default)(this, "getCode", function () {
     return _this.attributes.code;
   });
+  // string # Error message
   (0, _defineProperty2.default)(this, "getMessage", function () {
     return _this.attributes.message;
   });
+  // string # Status message
   (0, _defineProperty2.default)(this, "getStatus", function () {
     return _this.attributes.status;
   });
+  // Auto # Additional data
   (0, _defineProperty2.default)(this, "getData", function () {
     return _this.attributes.data;
   });
+  // array # A list of api errors
   (0, _defineProperty2.default)(this, "getErrors", function () {
     return _this.attributes.errors;
   });
+  // int64 # Required Clickwrap id
   (0, _defineProperty2.default)(this, "getClickwrapId", function () {
     return _this.attributes.clickwrap_id;
   });
+  // string # Required Clickwrap body
   (0, _defineProperty2.default)(this, "getClickwrapBody", function () {
     return _this.attributes.clickwrap_body;
   });

package/lib/models/Style.js

@@ -31,36 +31,43 @@ var Style = /*#__PURE__*/(0, _createClass2.default)(function Style() {
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.path;
   });
+  // int64 # Style ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
   (0, _defineProperty2.default)(this, "setId", function (value) {
     _this.attributes.id = value;
   });
+  // string # Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
   (0, _defineProperty2.default)(this, "getPath", function () {
     return _this.attributes.path;
   });
   (0, _defineProperty2.default)(this, "setPath", function (value) {
     _this.attributes.path = value;
   });
+  // Image # Logo
   (0, _defineProperty2.default)(this, "getLogo", function () {
     return _this.attributes.logo;
   });
   (0, _defineProperty2.default)(this, "setLogo", function (value) {
     _this.attributes.logo = value;
   });
+  // Image # Logo thumbnail
   (0, _defineProperty2.default)(this, "getThumbnail", function () {
     return _this.attributes.thumbnail;
   });
   (0, _defineProperty2.default)(this, "setThumbnail", function (value) {
     _this.attributes.thumbnail = value;
   });
+  // file # Logo for custom branding.
   (0, _defineProperty2.default)(this, "getFile", function () {
     return _this.attributes.file;
   });
   (0, _defineProperty2.default)(this, "setFile", function (value) {
     _this.attributes.file = value;
   });
+  // Parameters:
+  //   file (required) - file - Logo for custom branding.
   (0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
     var params,
       response,
@@ -199,6 +206,8 @@ var Style = /*#__PURE__*/(0, _createClass2.default)(function Style() {
   });
   this.options = _objectSpread({}, options);
 });
+// Parameters:
+//   path (required) - string - Style path.
 (0, _defineProperty2.default)(Style, "find", /*#__PURE__*/function () {
   var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(path) {
     var params,

package/lib/models/UsageDailySnapshot.js

@@ -31,36 +31,47 @@ var UsageDailySnapshot = /*#__PURE__*/(0, _createClass2.default)(function UsageD
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # ID of the usage record
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
+  // date # The date of this usage record
   (0, _defineProperty2.default)(this, "getDate", function () {
     return _this.attributes.date;
   });
+  // 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.
   (0, _defineProperty2.default)(this, "getApiUsageAvailable", function () {
     return _this.attributes.api_usage_available;
   });
+  // int64 # Read API Calls used on this day. Note: only updated for days before the current day.
   (0, _defineProperty2.default)(this, "getReadApiUsage", function () {
     return _this.attributes.read_api_usage;
   });
+  // int64 # Write API Calls used on this day. Note: only updated for days before the current day.
   (0, _defineProperty2.default)(this, "getWriteApiUsage", function () {
     return _this.attributes.write_api_usage;
   });
+  // int64 # Number of billable users as of this day.
   (0, _defineProperty2.default)(this, "getUserCount", function () {
     return _this.attributes.user_count;
   });
+  // int64 # GB of Files Native Storage used on this day.
   (0, _defineProperty2.default)(this, "getCurrentStorage", function () {
     return _this.attributes.current_storage;
   });
+  // int64 # GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
   (0, _defineProperty2.default)(this, "getDeletedFilesStorage", function () {
     return _this.attributes.deleted_files_storage;
   });
+  // 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.
   (0, _defineProperty2.default)(this, "getDeletedFilesCountedInMinimum", function () {
     return _this.attributes.deleted_files_counted_in_minimum;
   });
+  // 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`
   (0, _defineProperty2.default)(this, "getRootStorage", function () {
     return _this.attributes.root_storage;
   });
+  // object # Usage broken down by each top-level folder
   (0, _defineProperty2.default)(this, "getUsageByTopLevelDir", function () {
     return _this.attributes.usage_by_top_level_dir;
   });
@@ -77,6 +88,16 @@ var UsageDailySnapshot = /*#__PURE__*/(0, _createClass2.default)(function UsageD
   });
   this.options = _objectSpread({}, options);
 });
+// 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 ]`.
 (0, _defineProperty2.default)(UsageDailySnapshot, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,

package/lib/models/UsageSnapshot.js

@@ -31,48 +31,63 @@ var UsageSnapshot = /*#__PURE__*/(0, _createClass2.default)(function UsageSnapsh
   (0, _defineProperty2.default)(this, "isLoaded", function () {
     return !!_this.attributes.id;
   });
+  // int64 # Usage snapshot ID
   (0, _defineProperty2.default)(this, "getId", function () {
     return _this.attributes.id;
   });
+  // date-time # Usage snapshot start date/time
   (0, _defineProperty2.default)(this, "getStartAt", function () {
     return _this.attributes.start_at;
   });
+  // date-time # Usage snapshot end date/time
   (0, _defineProperty2.default)(this, "getEndAt", function () {
     return _this.attributes.end_at;
   });
+  // double # Highest user count number in time period
   (0, _defineProperty2.default)(this, "getHighWaterUserCount", function () {
     return _this.attributes.high_water_user_count;
   });
+  // double # Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)
   (0, _defineProperty2.default)(this, "getCurrentStorage", function () {
     return _this.attributes.current_storage;
   });
+  // double # Highest Storage Usage GB recorded in time period (used for billing)
   (0, _defineProperty2.default)(this, "getHighWaterStorage", function () {
     return _this.attributes.high_water_storage;
   });
+  // object # Storage Usage - map of root folders to their usage as of end date (not necessarily high water mark, which is used for billing)
   (0, _defineProperty2.default)(this, "getUsageByTopLevelDir", function () {
     return _this.attributes.usage_by_top_level_dir;
   });
+  // double # Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)
   (0, _defineProperty2.default)(this, "getRootStorage", function () {
     return _this.attributes.root_storage;
   });
+  // 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)
   (0, _defineProperty2.default)(this, "getDeletedFilesCountedInMinimum", function () {
     return _this.attributes.deleted_files_counted_in_minimum;
   });
+  // 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)
   (0, _defineProperty2.default)(this, "getDeletedFilesStorage", function () {
     return _this.attributes.deleted_files_storage;
   });
+  // double # Storage + Transfer Usage - Total Billable amount
   (0, _defineProperty2.default)(this, "getTotalBillableUsage", function () {
     return _this.attributes.total_billable_usage;
   });
+  // double # Transfer usage for period - Total Billable amount
   (0, _defineProperty2.default)(this, "getTotalBillableTransferUsage", function () {
     return _this.attributes.total_billable_transfer_usage;
   });
+  // double # Transfer Usage for period - Outbound GB from Files Native Storage
   (0, _defineProperty2.default)(this, "getBytesSent", function () {
     return _this.attributes.bytes_sent;
   });
+  // double # Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)
   (0, _defineProperty2.default)(this, "getSyncBytesReceived", function () {
     return _this.attributes.sync_bytes_received;
   });
+  // double # Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)
   (0, _defineProperty2.default)(this, "getSyncBytesSent", function () {
     return _this.attributes.sync_bytes_sent;
   });
@@ -89,6 +104,9 @@ var UsageSnapshot = /*#__PURE__*/(0, _createClass2.default)(function UsageSnapsh
   });
   this.options = _objectSpread({}, options);
 });
+// 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).
 (0, _defineProperty2.default)(UsageSnapshot, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
   var _response$data;
   var params,