files.com 1.0.55 → 1.0.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecbeaa79c9bc8e09a208a934587c1e2012e654d5f0d86fa2870b66e158f56884
-  data.tar.gz: e2e2e3e577c6563f5e69435b68564f58048b2e29212871f816ba45edd2503c2a
+  metadata.gz: c690446029bc7e1ef335fa91a9dd7b3601e3a845d9119e5baf7299567b1c0ff8
+  data.tar.gz: 04415de4081598065d3c06335f110f6f74d10555e697f93686fbffea17ca9458
 SHA512:
-  metadata.gz: 5b5f3bab8adccf57c74a1049f989c49e775bdd60ce1966ac5441f00e2e626badcd562b1f84d2c8a14166638b665e74ee80ef737446af863d94c4c87072b21802
-  data.tar.gz: e2ad85a93de9372f46363185ec55675fe19c87696ccde92915b330e7af8f567968d197116823edc7028a8df86e736a2a9eb757a6aca32e8c3f20bd3702acc55a
+  metadata.gz: 987afa0cc9011dc90acf572b5fff8a667cd5345ee6b31da8bb580b1034184705c7ac723a8deb7a027bfdec572c44f5ce8f703a65e48e2ce7a6bd6d086b6a5a27
+  data.tar.gz: 8e3701ed6eb9d2b7b0d20bd5441bbcb51cac61f8726115af5ec9615e09205b94c75c8953cf8caaf2c5b252db1f3a82204a85b0bf53dd9c7c65a10f0f5057f0c4

data/_VERSION

@@ -1 +1 @@
-1.0.55
+1.0.60

data/docs/bundle.md

@@ -77,8 +77,8 @@ Files::Bundle.create(
   paths: ["file.txt"], 
   password: "Password", 
   expires_at: "2000-01-01T01:00:00Z", 
-  description: "Public description", 
-  note: "Internal Note", 
+  description: "The public description of the bundle.", 
+  note: "The internal note on the bundle.", 
   code: "abc123"
 )
 ```
@@ -88,10 +88,10 @@ Files::Bundle.create(
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `paths` (array(string)): Required - A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
-* `expires_at` (string): Bundle expiration date/time.
-* `description` (string): Bundle public description
+* `expires_at` (string): Bundle expiration date/time
+* `description` (string): Public description
 * `note` (string): Bundle internal note
-* `code` (string): Bundle name
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
 
 
 ---
@@ -112,6 +112,30 @@ Files::Bundle.share(id,
 * `note` (string): Note to include in email.
 
 
+---
+
+## Update Bundle
+
+```
+Files::Bundle.update(id, 
+  password: "Password", 
+  expires_at: "2000-01-01T01:00:00Z", 
+  description: "The public description of the bundle.", 
+  note: "The internal note on the bundle.", 
+  code: "abc123"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `password` (string): Password for this bundle.
+* `expires_at` (string): Bundle expiration date/time
+* `description` (string): Public description
+* `note` (string): Bundle internal note
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
+
+
 ---
 
 ## Delete Bundle
@@ -144,6 +168,31 @@ bundle.share(
 * `note` (string): Note to include in email.
 
 
+---
+
+## Update Bundle
+
+```
+bundle = Files::Bundle.find(1)
+bundle.update(
+  password: "Password",
+  expires_at: "2000-01-01T01:00:00Z",
+  description: "The public description of the bundle.",
+  note: "The internal note on the bundle.",
+  code: "abc123"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `password` (string): Password for this bundle.
+* `expires_at` (string): Bundle expiration date/time
+* `description` (string): Public description
+* `note` (string): Bundle internal note
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
+
+
 ---
 
 ## Delete Bundle

data/docs/remote_server.md

@@ -13,6 +13,7 @@
   "s3_bucket": "my-bucket",
   "s3_region": "us-east-1",
   "server_certificate": "[certificate]",
+  "server_host_key": "[public key]",
   "server_type": "s3",
   "ssl": "always",
   "username": "user",
@@ -34,6 +35,7 @@
 * `s3_bucket` (string): S3 bucket name
 * `s3_region` (string): S3 region
 * `server_certificate` (string): Remote server certificate
+* `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
 * `server_type` (string): Remote server type.
 * `ssl` (string): Should we require SSL?
 * `username` (string): Remote server username.  Not needed for S3 buckets.
@@ -98,6 +100,7 @@ Files::RemoteServer.create(
   s3_bucket: "my-bucket", 
   s3_region: "us-east-1", 
   server_certificate: "[certificate]", 
+  server_host_key: "[public key]", 
   server_type: "s3", 
   ssl: "always", 
   username: "user", 
@@ -128,6 +131,7 @@ Files::RemoteServer.create(
 * `s3_bucket` (string): S3 bucket name
 * `s3_region` (string): S3 region
 * `server_certificate` (string): Remote server certificate
+* `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
 * `server_type` (string): Remote server type.
 * `ssl` (string): Should we require SSL?
 * `username` (string): Remote server username.  Not needed for S3 buckets.
@@ -152,6 +156,7 @@ Files::RemoteServer.update(id,
   s3_bucket: "my-bucket", 
   s3_region: "us-east-1", 
   server_certificate: "[certificate]", 
+  server_host_key: "[public key]", 
   server_type: "s3", 
   ssl: "always", 
   username: "user", 
@@ -183,6 +188,7 @@ Files::RemoteServer.update(id,
 * `s3_bucket` (string): S3 bucket name
 * `s3_region` (string): S3 region
 * `server_certificate` (string): Remote server certificate
+* `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
 * `server_type` (string): Remote server type.
 * `ssl` (string): Should we require SSL?
 * `username` (string): Remote server username.  Not needed for S3 buckets.
@@ -221,6 +227,7 @@ remote_server.update(
   s3_bucket: "my-bucket",
   s3_region: "us-east-1",
   server_certificate: "[certificate]",
+  server_host_key: "[public key]",
   server_type: "s3",
   ssl: "always",
   username: "user",
@@ -252,6 +259,7 @@ remote_server.update(
 * `s3_bucket` (string): S3 bucket name
 * `s3_region` (string): S3 region
 * `server_certificate` (string): Remote server certificate
+* `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
 * `server_type` (string): Remote server type.
 * `ssl` (string): Should we require SSL?
 * `username` (string): Remote server username.  Not needed for S3 buckets.

data/docs/site.md

@@ -262,7 +262,7 @@ Files::Site.update(
   desktop_app_session_lifetime: 1, 
   folder_permissions_groups_only: true, 
   welcome_screen: "user_controlled", 
-  session_expiry: 6.0, 
+  session_expiry: 1.0, 
   ssl_required: true, 
   tls_disabled: true, 
   user_lockout: true, 
@@ -349,7 +349,7 @@ Files::Site.update(
 * `desktop_app_session_lifetime` (int64): Desktop app session lifetime (in hours)
 * `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
 * `welcome_screen` (string): Does the welcome screen appear?
-* `session_expiry` (number): Session expiry in hours
+* `session_expiry` (double): Session expiry in hours
 * `ssl_required` (boolean): Is SSL required?  Disabling this is insecure.
 * `tls_disabled` (boolean): Is TLS disabled(site setting)?
 * `user_lockout` (boolean): Will users be locked out after incorrect login attempts?

data/docs/sso_strategy.md

@@ -6,6 +6,8 @@
 {
   "protocol": "okta",
   "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": "",
@@ -24,13 +26,28 @@
   "provision_attachments_permission": true,
   "provision_dav_permission": true,
   "provision_ftp_permission": true,
+  "provision_group_action": "disabled",
   "provision_sftp_permission": true,
-  "provision_time_zone": "Eastern Time (US & Canada)"
+  "provision_time_zone": "Eastern Time (US & Canada)",
+  "provision_user_action": "disabled",
+  "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_user_include_groups": "",
+  "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
@@ -49,8 +66,21 @@
 * `provision_attachments_permission` (boolean): Auto-provisioned users get Sharing permission?
 * `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
 * `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
+* `provision_group_action` (string): Should we sync groups from this strategy?
 * `provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
 * `provision_time_zone` (string): Default time zone for auto provisioned users.
+* `provision_user_action` (string): Should we sync users from this strategy?
+* `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?
+* `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_user_include_groups` (string): Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
+* `ldap_username` (string): Username for signing in to LDAP server.
+* `ldap_username_field` (string): LDAP username field
 
 
 ---

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

@@ -136,9 +136,9 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
@@ -159,7 +159,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - Api Key ID.
+    #   id (required) - int64 - Api Key ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -175,7 +175,7 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   name - string - Internal name for key.  For your reference only.
     #   permission_set - string - Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
     #   expires_at - string - Have the key expire at this date/time.

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

@@ -97,9 +97,9 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
@@ -115,7 +115,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - As2 Key ID.
+    #   id (required) - int64 - As2 Key ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -131,7 +131,7 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   as2_partnership_name (required) - string - AS2 Partnership Name
     #   public_key (required) - string - Actual contents of Public key.
     def self.create(params = {}, options = {})

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

@@ -180,8 +180,8 @@ module Files
     end
 
     # Parameters:
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     #   automation - string - Type of automation to filter by.
     def self.list(params = {}, options = {})
@@ -198,7 +198,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - Automation ID.
+    #   id (required) - int64 - Automation ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

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

@@ -101,8 +101,8 @@ module Files
     end
 
     # Parameters:
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     #   behavior - string - If set, only shows folder behaviors matching this behavior type.
     def self.list(params = {}, options = {})
@@ -119,8 +119,8 @@ module Files
     end
 
     # Parameters:
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     #   path (required) - string - Path to operate on.
     #   recursive - string - Show behaviors below this path?
@@ -140,7 +140,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - Behavior ID.
+    #   id (required) - int64 - Behavior ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

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

@@ -116,7 +116,7 @@ module Files
     # Send email(s) with a link to bundle
     #
     # Parameters:
-    #   to (required) - array - A list of email addresses to share this bundle with.
+    #   to (required) - array(string) - A list of email addresses to share this bundle with.
     #   note - string - Note to include in email.
     def share(params = {})
       params ||= {}
@@ -131,6 +131,27 @@ module Files
       Api.send_request("/bundles/#{@attributes[:id]}/share", :post, params, @options)
     end
 
+    # Parameters:
+    #   password - string - Password for this bundle.
+    #   expires_at - string - Bundle expiration date/time
+    #   description - string - Public description
+    #   note - string - Bundle internal note
+    #   code - string - Bundle code.  This code forms the end part of the Public URL.
+    def update(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/bundles/#{@attributes[:id]}", :patch, params, @options)
+    end
+
     def delete(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -147,7 +168,7 @@ module Files
 
     def save
       if @attributes[:id]
-        raise NotImplementedError.new("The Bundle object doesn't support updates.")
+        update(@attributes)
       else
         new_obj = Bundle.create(@attributes, @options)
         @attributes = new_obj.attributes
@@ -155,9 +176,9 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
-    #   page - integer - Current page number.
-    #   per_page - integer - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
     def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
@@ -173,7 +194,7 @@ module Files
     end
 
     # Parameters:
-    #   id (required) - integer - Bundle ID.
+    #   id (required) - int64 - Bundle ID.
     def self.find(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -189,13 +210,13 @@ module Files
     end
 
     # Parameters:
-    #   user_id - integer - User ID.  Provide a value of `0` to operate the current session's user.
-    #   paths (required) - array - A list of paths to include in this bundle.
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   paths (required) - array(string) - A list of paths to include in this bundle.
     #   password - string - Password for this bundle.
-    #   expires_at - string - Bundle expiration date/time.
-    #   description - string - Bundle public description
+    #   expires_at - string - Bundle expiration date/time
+    #   description - string - Public description
     #   note - string - Bundle internal note
-    #   code - string - Bundle name
+    #   code - string - Bundle code.  This code forms the end part of the Public URL.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
@@ -213,7 +234,7 @@ module Files
     # Send email(s) with a link to bundle
     #
     # Parameters:
-    #   to (required) - array - A list of email addresses to share this bundle with.
+    #   to (required) - array(string) - A list of email addresses to share this bundle with.
     #   note - string - Note to include in email.
     def self.share(id, params = {}, options = {})
       params ||= {}
@@ -228,6 +249,27 @@ module Files
       response.data
     end
 
+    # Parameters:
+    #   password - string - Password for this bundle.
+    #   expires_at - string - Bundle expiration date/time
+    #   description - string - Public description
+    #   note - string - Bundle internal note
+    #   code - string - Bundle code.  This code forms the end part of the Public URL.
+    def self.update(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/bundles/#{params[:id]}", :patch, params, options)
+      Bundle.new(response.data, options)
+    end
+
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id