files.com 1.0.295 → 1.0.297

data/docs/site.md

@@ -14,16 +14,15 @@
   "admin_user_id": 1,
   "allow_bundle_names": true,
   "allowed_countries": "US,DE",
-  "allowed_ips": "",
+  "allowed_ips": "example",
   "ask_about_overwrites": true,
   "bundle_expiration": 1,
   "bundle_password_required": true,
   "bundle_require_share_recipient": true,
-  "bundle_watermark_attachment": {
-    "name": "My logo",
-    "uri": "https://mysite.files.com/.../my_image.png"
+  "bundle_watermark_attachment": "",
+  "bundle_watermark_value": {
+    "key": "example value"
   },
-  "bundle_watermark_value": "",
   "color2_left": "#0066a7",
   "color2_link": "#d34f5d",
   "color2_text": "#0066a7",
@@ -47,39 +46,27 @@
   "disable_password_reset": true,
   "domain": "my-custom-domain.com",
   "domain_hsts_header": true,
-  "domain_letsencrypt_chain": "",
-  "email": "john.doe@files.com",
+  "domain_letsencrypt_chain": "example",
+  "email": "example",
   "ftp_enabled": true,
-  "reply_to_email": "jane.doe@files.com",
+  "reply_to_email": "example",
   "non_sso_groups_allowed": true,
   "non_sso_users_allowed": true,
   "folder_permissions_groups_only": true,
   "hipaa": true,
-  "icon128": {
-    "name": "My logo",
-    "uri": "https://mysite.files.com/.../my_image.png"
-  },
-  "icon16": {
-    "name": "My logo",
-    "uri": "https://mysite.files.com/.../my_image.png"
-  },
-  "icon32": {
-    "name": "My logo",
-    "uri": "https://mysite.files.com/.../my_image.png"
-  },
-  "icon48": {
-    "name": "My logo",
-    "uri": "https://mysite.files.com/.../my_image.png"
-  },
+  "icon128": "",
+  "icon16": "",
+  "icon32": "",
+  "icon48": "",
   "immutable_files_set_at": "2000-01-01T01:00:00Z",
   "include_password_in_welcome_email": true,
   "language": "en",
-  "ldap_base_dn": "",
+  "ldap_base_dn": "example",
   "ldap_domain": "mysite.com",
   "ldap_enabled": true,
   "ldap_group_action": "disabled",
-  "ldap_group_exclusion": "",
-  "ldap_group_inclusion": "",
+  "ldap_group_exclusion": "example",
+  "ldap_group_inclusion": "example",
   "ldap_host": "ldap.site.com",
   "ldap_host_2": "ldap2.site.com",
   "ldap_host_3": "ldap3.site.com",
@@ -87,15 +74,15 @@
   "ldap_secure": true,
   "ldap_type": "open_ldap",
   "ldap_user_action": "disabled",
-  "ldap_user_include_groups": "",
+  "ldap_user_include_groups": "example",
   "ldap_username": "[ldap username]",
   "ldap_username_field": "sAMAccountName",
   "login_help_text": "Login page help text.",
-  "logo": {
-    "name": "My logo",
-    "uri": "https://mysite.files.com/.../my_image.png"
-  },
+  "logo": "",
   "max_prior_passwords": 1,
+  "motd_text": "example",
+  "motd_use_for_ftp": true,
+  "motd_use_for_sftp": true,
   "next_billing_amount": 1.0,
   "next_billing_date": "Apr 20",
   "office_integration_available": true,
@@ -117,36 +104,15 @@
   "require_2fa": true,
   "require_2fa_stop_time": "2000-01-01T01:00:00Z",
   "require_2fa_user_type": "`site_admins`",
-  "session": {
-    "id": "60525f92e859c4c3d74cb02fd176b1525901b525",
-    "language": "en",
-    "login_token": "@tok-randomcode",
-    "login_token_domain": "https://mysite.files.com",
-    "max_dir_listing_size": false,
-    "multiple_regions": true,
-    "read_only": true,
-    "root_path": "",
-    "sftp_insecure_ciphers": false,
-    "site_id": 1,
-    "ssl_required": true,
-    "tls_disabled": false,
-    "two_factor_setup_needed": false,
-    "allowed_2fa_method_sms": true,
-    "allowed_2fa_method_totp": true,
-    "allowed_2fa_method_u2f": true,
-    "allowed_2fa_method_webauthn": true,
-    "allowed_2fa_method_yubi": true,
-    "use_provided_modified_at": true,
-    "windows_mode_ftp": false
-  },
+  "session": "",
   "session_pinned_by_ip": true,
   "sftp_enabled": true,
   "sftp_insecure_ciphers": true,
   "sftp_user_root_enabled": true,
   "sharing_enabled": true,
   "show_request_access_link": true,
-  "site_footer": "",
-  "site_header": "",
+  "site_footer": "example",
+  "site_header": "example",
   "smtp_address": "smtp.my-mail-server.com",
   "smtp_authentication": "plain",
   "smtp_from": "me@my-mail-server.com",
@@ -161,60 +127,7 @@
   "trial_until": "2000-01-01T01:00:00Z",
   "updated_at": "2000-01-01T01:00:00Z",
   "use_provided_modified_at": true,
-  "user": {
-    "id": 1,
-    "username": "user",
-    "admin_group_ids": [
-      1
-    ],
-    "allowed_ips": "127.0.0.1",
-    "attachments_permission": true,
-    "api_keys_count": 1,
-    "authenticate_until": "2000-01-01T01:00:00Z",
-    "authentication_method": "password",
-    "avatar_url": "",
-    "billing_permission": false,
-    "bypass_site_allowed_ips": false,
-    "bypass_inactive_disable": false,
-    "created_at": "2000-01-01T01:00:00Z",
-    "dav_permission": true,
-    "disabled": true,
-    "email": "john.doe@files.com",
-    "first_login_at": "2000-01-01T01:00:00Z",
-    "ftp_permission": true,
-    "group_ids": "",
-    "header_text": "User-specific message.",
-    "language": "en",
-    "last_login_at": "2000-01-01T01:00:00Z",
-    "last_protocol_cipher": "",
-    "lockout_expires": "2000-01-01T01:00:00Z",
-    "name": "John Doe",
-    "company": "ACME Corp.",
-    "notes": "Internal notes on this user.",
-    "notification_daily_send_time": 18,
-    "office_integration_enabled": true,
-    "password_set_at": "2000-01-01T01:00:00Z",
-    "password_validity_days": 1,
-    "public_keys_count": 1,
-    "receive_admin_alerts": true,
-    "require_2fa": "always_require",
-    "active_2fa": true,
-    "require_password_change": true,
-    "password_expired": true,
-    "restapi_permission": true,
-    "self_managed": true,
-    "sftp_permission": true,
-    "site_admin": true,
-    "skip_welcome_screen": true,
-    "ssl_required": "always_require",
-    "sso_strategy_id": 1,
-    "subscribe_to_newsletter": true,
-    "externally_managed": true,
-    "time_zone": "Pacific Time (US & Canada)",
-    "type_of_2fa": "yubi",
-    "updated_at": "2000-01-01T01:00:00Z",
-    "user_root": ""
-  },
+  "user": "",
   "user_lockout": true,
   "user_lockout_lock_period": 1,
   "user_lockout_tries": 1,
@@ -222,8 +135,8 @@
   "user_requests_enabled": true,
   "user_requests_notify_admins": true,
   "welcome_custom_text": "Welcome to my site!",
-  "welcome_email_cc": "",
-  "welcome_email_subject": "",
+  "welcome_email_cc": "example",
+  "welcome_email_subject": "example",
   "welcome_email_enabled": true,
   "welcome_screen": "user_controlled",
   "windows_mode_ftp": true,
@@ -305,6 +218,9 @@
 * `login_help_text` (string): Login help text
 * `logo` (Image): Branded logo
 * `max_prior_passwords` (int64): Number of prior passwords to disallow
+* `motd_text` (string): A message to show users when they connect via FTP or SFTP.
+* `motd_use_for_ftp` (boolean): Show message to users connecting via FTP
+* `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
 * `next_billing_amount` (double): Next billing amount
 * `next_billing_date` (string): Next billing date
 * `office_integration_available` (boolean): Allow users to use Office for the web?
@@ -393,14 +309,17 @@ Files::Site.update(
   subdomain: "mysite", 
   domain: "my-custom-domain.com", 
   domain_hsts_header: true, 
-  email: "john.doe@files.com", 
-  reply_to_email: "jane.doe@files.com", 
+  domain_letsencrypt_chain: "example", 
+  email: "example", 
+  reply_to_email: "example", 
   allow_bundle_names: true, 
   bundle_expiration: 1, 
   overage_notify: true, 
   welcome_email_enabled: true, 
   ask_about_overwrites: true, 
   show_request_access_link: true, 
+  welcome_email_cc: "example", 
+  welcome_email_subject: "example", 
   welcome_custom_text: "Welcome to my site!", 
   language: "en", 
   windows_mode_ftp: true, 
@@ -415,6 +334,9 @@ Files::Site.update(
   welcome_screen: "user_controlled", 
   office_integration_available: true, 
   pin_all_remote_servers_to_site_region: true, 
+  motd_text: "example", 
+  motd_use_for_ftp: true, 
+  motd_use_for_sftp: true, 
   session_expiry: 1.0, 
   ssl_required: true, 
   tls_disabled: true, 
@@ -426,6 +348,7 @@ Files::Site.update(
   user_lockout_lock_period: 1, 
   include_password_in_welcome_email: true, 
   allowed_countries: "US,DE", 
+  allowed_ips: "example", 
   disallowed_countries: "US,DE", 
   days_to_retain_backups: 1, 
   max_prior_passwords: 1, 
@@ -454,6 +377,7 @@ Files::Site.update(
   user_requests_notify_admins: true, 
   ftp_enabled: true, 
   sftp_enabled: true, 
+  bundle_watermark_value: {"key":"example value"}, 
   allowed_2fa_method_sms: true, 
   allowed_2fa_method_u2f: true, 
   allowed_2fa_method_totp: true, 
@@ -467,6 +391,8 @@ Files::Site.update(
   color2_link: "#d34f5d", 
   color2_text: "#0066a7", 
   color2_top_text: "#ffffff", 
+  site_header: "example", 
+  site_footer: "example", 
   login_help_text: "Login page help text.", 
   smtp_address: "smtp.my-mail-server.com", 
   smtp_authentication: "plain", 
@@ -485,6 +411,10 @@ Files::Site.update(
   ldap_domain: "mysite.com", 
   ldap_user_action: "disabled", 
   ldap_group_action: "disabled", 
+  ldap_user_include_groups: "example", 
+  ldap_group_exclusion: "example", 
+  ldap_group_inclusion: "example", 
+  ldap_base_dn: "example", 
   icon16_delete: true, 
   icon32_delete: true, 
   icon48_delete: true, 
@@ -526,6 +456,9 @@ Files::Site.update(
 * `welcome_screen` (string): Does the welcome screen appear?
 * `office_integration_available` (boolean): Allow users to use Office for the web?
 * `pin_all_remote_servers_to_site_region` (boolean): If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
+* `motd_text` (string): A message to show users when they connect via FTP or SFTP.
+* `motd_use_for_ftp` (boolean): Show message to users connecting via FTP
+* `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
 * `session_expiry` (double): Session expiry in hours
 * `ssl_required` (boolean): Is SSL required?  Disabling this is insecure.
 * `tls_disabled` (boolean): Are Insecure TLS and SFTP Ciphers allowed?  Enabling this is insecure.

data/docs/sso_strategy.md

@@ -9,16 +9,16 @@
   "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": "",
+  "saml_provider_cert_fingerprint": "example",
+  "saml_provider_issuer_url": "example",
+  "saml_provider_metadata_content": "example",
+  "saml_provider_metadata_url": "example",
+  "saml_provider_slo_target_url": "example",
+  "saml_provider_sso_target_url": "example",
+  "scim_authentication_method": "example",
+  "scim_username": "example",
+  "scim_oauth_access_token": "example",
+  "scim_oauth_access_token_expires_at": "example",
   "subdomain": "my-site",
   "provision_users": true,
   "provision_groups": true,
@@ -28,7 +28,7 @@
   "provision_group_default": "Employees",
   "provision_group_exclusion": "Employees",
   "provision_group_inclusion": "Employees",
-  "provision_group_required": "",
+  "provision_group_required": "example",
   "provision_email_signup_groups": "Employees",
   "provision_site_admin_groups": "Employees",
   "provision_attachments_permission": true,
@@ -37,7 +37,7 @@
   "provision_sftp_permission": true,
   "provision_time_zone": "Eastern Time (US & Canada)",
   "provision_company": "ACME Corp.",
-  "ldap_base_dn": "",
+  "ldap_base_dn": "example",
   "ldap_domain": "mysite.com",
   "enabled": true,
   "ldap_host": "ldap.site.com",

data/docs/status.md

@@ -5,21 +5,14 @@
 ```
 {
   "code": 200,
-  "message": "",
+  "message": "example",
   "status": "",
-  "data": "",
+  "data": "example",
   "errors": [
-    {
-      "fields": [
-
-      ],
-      "messages": [
-
-      ]
-    }
+    null
   ],
   "clickwrap_id": 1,
-  "clickwrap_body": ""
+  "clickwrap_body": "example"
 }
 ```
 

data/docs/style.md

@@ -5,9 +5,9 @@
 ```
 {
   "id": 1,
-  "path": "",
+  "path": "example",
   "logo": "https://mysite.files.com/...",
-  "thumbnail": ""
+  "thumbnail": "example"
 }
 ```
 

data/docs/usage_daily_snapshot.md

@@ -5,16 +5,18 @@
 ```
 {
   "id": 1,
-  "date": "2020-11-21",
+  "date": "2000-01-01T01:00:00Z",
   "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": ""
+  "read_api_usage": 1,
+  "write_api_usage": 1,
+  "user_count": 1,
+  "current_storage": 1,
+  "deleted_files_storage": 1,
+  "deleted_files_counted_in_minimum": 1,
+  "root_storage": 1,
+  "usage_by_top_level_dir": {
+    "key": "example value"
+  }
 }
 ```
 

data/docs/usage_snapshot.md

@@ -14,7 +14,9 @@
   "total_downloads": 1,
   "total_uploads": 1,
   "updated_at": "2000-01-01T01:00:00Z",
-  "usage_by_top_level_dir": "",
+  "usage_by_top_level_dir": {
+    "key": "example value"
+  },
   "root_storage": 1.0,
   "deleted_files_counted_in_minimum": 1.0,
   "deleted_files_storage": 1.0,

data/docs/user.md

@@ -14,21 +14,21 @@
   "api_keys_count": 1,
   "authenticate_until": "2000-01-01T01:00:00Z",
   "authentication_method": "password",
-  "avatar_url": "",
+  "avatar_url": "example",
   "billing_permission": true,
   "bypass_site_allowed_ips": true,
   "bypass_inactive_disable": true,
   "created_at": "2000-01-01T01:00:00Z",
   "dav_permission": true,
   "disabled": true,
-  "email": "john.doe@files.com",
+  "email": "example",
   "first_login_at": "2000-01-01T01:00:00Z",
   "ftp_permission": true,
-  "group_ids": "",
+  "group_ids": "example",
   "header_text": "User-specific message.",
   "language": "en",
   "last_login_at": "2000-01-01T01:00:00Z",
-  "last_protocol_cipher": "",
+  "last_protocol_cipher": "example",
   "lockout_expires": "2000-01-01T01:00:00Z",
   "name": "John Doe",
   "company": "ACME Corp.",
@@ -55,7 +55,7 @@
   "time_zone": "Pacific Time (US & Canada)",
   "type_of_2fa": "yubi",
   "updated_at": "2000-01-01T01:00:00Z",
-  "user_root": ""
+  "user_root": "example"
 }
 ```
 
@@ -173,8 +173,9 @@ Files::User.find(id)
 ```
 Files::User.create(
   avatar_delete: true, 
-  email: "john.doe@files.com", 
+  email: "example", 
   group_id: 1, 
+  group_ids: "example", 
   announcements_read: true, 
   allowed_ips: "127.0.0.1", 
   attachments_permission: true, 
@@ -206,6 +207,7 @@ Files::User.create(
   subscribe_to_newsletter: true, 
   require_2fa: "always_require", 
   time_zone: "Pacific Time (US & Canada)", 
+  user_root: "example", 
   username: "user"
 )
 ```
@@ -304,8 +306,9 @@ Files::User.user_2fa_reset(id)
 ```
 Files::User.update(id, 
   avatar_delete: true, 
-  email: "john.doe@files.com", 
+  email: "example", 
   group_id: 1, 
+  group_ids: "example", 
   announcements_read: true, 
   allowed_ips: "127.0.0.1", 
   attachments_permission: true, 
@@ -337,6 +340,7 @@ Files::User.update(id,
   subscribe_to_newsletter: true, 
   require_2fa: "always_require", 
   time_zone: "Pacific Time (US & Canada)", 
+  user_root: "example", 
   username: "user"
 )
 ```
@@ -457,8 +461,9 @@ user = Files::User.list.first
 
 user.update(
   avatar_delete: true,
-  email: "john.doe@files.com",
+  email: "example",
   group_id: 1,
+  group_ids: "example",
   announcements_read: true,
   allowed_ips: "127.0.0.1",
   attachments_permission: true,
@@ -490,6 +495,7 @@ user.update(
   subscribe_to_newsletter: true,
   require_2fa: "always_require",
   time_zone: "Pacific Time (US & Canada)",
+  user_root: "example",
   username: "user"
 )
 ```

data/docs/user_request.md

@@ -6,7 +6,7 @@
 {
   "id": 1,
   "name": "John Doe",
-  "email": "john.doe@files.com",
+  "email": "example",
   "details": "Changed Departments"
 }
 ```

data/docs/webhook_test.md

@@ -7,7 +7,7 @@
   "code": 200,
   "message": "",
   "status": "",
-  "data": "",
+  "data": "example",
   "success": true
 }
 ```
@@ -37,10 +37,10 @@ Files::WebhookTest.create(
   url: "https://www.site.com/...", 
   method: "GET", 
   encoding: "RAW", 
-  headers: "x-test-header => testvalue", 
-  body: "test-param => testvalue", 
+  headers: {"x-test-header":"testvalue"}, 
+  body: {"test-param":"testvalue"}, 
   raw_body: "test body", 
-  file_as_body: "false", 
+  file_as_body: true, 
   file_form_field: "upload_file_data", 
   action: "test"
 )

data/lib/files.com/models/site.rb

@@ -379,6 +379,21 @@ module Files
       @attributes[:max_prior_passwords]
     end
 
+    # string - A message to show users when they connect via FTP or SFTP.
+    def motd_text
+      @attributes[:motd_text]
+    end
+
+    # boolean - Show message to users connecting via FTP
+    def motd_use_for_ftp
+      @attributes[:motd_use_for_ftp]
+    end
+
+    # boolean - Show message to users connecting via SFTP
+    def motd_use_for_sftp
+      @attributes[:motd_use_for_sftp]
+    end
+
     # double - Next billing amount
     def next_billing_amount
       @attributes[:next_billing_amount]
@@ -709,6 +724,9 @@ module Files
     #   welcome_screen - string - Does the welcome screen appear?
     #   office_integration_available - boolean - Allow users to use Office for the web?
     #   pin_all_remote_servers_to_site_region - boolean - If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
+    #   motd_text - string - A message to show users when they connect via FTP or SFTP.
+    #   motd_use_for_ftp - boolean - Show message to users connecting via FTP
+    #   motd_use_for_sftp - boolean - Show message to users connecting via SFTP
     #   session_expiry - double - Session expiry in hours
     #   ssl_required - boolean - Is SSL required?  Disabling this is insecure.
     #   tls_disabled - boolean - Are Insecure TLS and SFTP Ciphers allowed?  Enabling this is insecure.
@@ -819,6 +837,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: desktop_app_session_lifetime must be an Integer") if params[:desktop_app_session_lifetime] and !params[:desktop_app_session_lifetime].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: mobile_app_session_lifetime must be an Integer") if params[:mobile_app_session_lifetime] and !params[:mobile_app_session_lifetime].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: welcome_screen must be an String") if params[:welcome_screen] and !params[:welcome_screen].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: motd_text must be an String") if params[:motd_text] and !params[:motd_text].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: session_expiry must be an Float") if params[:session_expiry] and !params[:session_expiry].is_a?(Float)
       raise InvalidParameterError.new("Bad parameter: user_lockout_tries must be an Integer") if params[:user_lockout_tries] and !params[:user_lockout_tries].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: user_lockout_within must be an Integer") if params[:user_lockout_within] and !params[:user_lockout_within].is_a?(Integer)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.295
+  version: 1.0.297
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable