files.com 1.0.72 → 1.0.77

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5397e4d501363c18da150487abd53f51c5598e1164c72f6fc931b889e30e369b
-  data.tar.gz: 86bd4ab54c0414bd15c193b5d1edaeafe2ae4a8941bf45264f510a0d876c6a8b
+  metadata.gz: d9a51f85cdfb6f53328a7ba37b464c4c1e92f741707e0598b4ed4b70a608b5dc
+  data.tar.gz: 5e3d7b201f518ff1f65c0ddc1943dee7f549693141935f950786b0293396c368
 SHA512:
-  metadata.gz: 1dbbc3649577ee65f36d4bb1447b7151cd82c8a27bc90927cede2528fcbc74e46f3c9af5dcd55ddf4a92653b9daac4cc5301ea3aa9edff005398efc7c7d7abcf
-  data.tar.gz: cdf2076851cf376f29f2970dae6afcdb0a4fbb98e5ca83ccbf50e8bfed8524a96cac5551a435ed17ef1b99a66122199b873a190766b88971e53fcd1dae184f14
+  metadata.gz: 28568c4de2bcf15925978fa9c645be7c4614bd276287103226bcafb949e001de1d07946274d82239c80b87ad1153bc9d1c8c194f64d5f75b1a0635265f97bb0b
+  data.tar.gz: 0e1a26eba12d2567865ef7d0555d088dce57710064eac501db9a6a9b870dfe7749800a7c9633bb75dbb03b036c1879063e499fd0b88dd7e29e3e5b4bc95d2610

data/Gemfile

@@ -3,10 +3,10 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'memory_profiler'
   gem 'pry'
   gem 'pry-byebug'
   gem 'rake', '~> 12.0.0'
   gem 'rspec', '~> 3.9.0'
   gem 'rubocop'
-  gem 'memory_profiler'
 end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    files.com (1.0)
+      addressable (>= 2.7.0)
+      concurrent-ruby (>= 1.1.3)
+      faraday (>= 1.0.1)
+      net-http-persistent
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    connection_pool (2.2.3)
+    diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    memory_profiler (0.9.14)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    net-http-persistent (4.0.0)
+      connection_pool (~> 2.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rake (12.0.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  files.com!
+  memory_profiler
+  pry
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.9.0)
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/_VERSION

@@ -1 +1 @@
-1.0.72
+1.0.77

data/docs/bundle.md

@@ -9,12 +9,16 @@
   "description": "The public description of the bundle.",
   "password_protected": true,
   "require_registration": true,
+  "clickwrap_body": "[Legal text]",
   "id": 1,
   "created_at": "2000-01-01T01:00:00Z",
   "expires_at": "2000-01-01T01:00:00Z",
+  "max_uses": 1,
   "note": "The internal note on the bundle.",
   "user_id": 1,
   "username": "user",
+  "clickwrap_id": 1,
+  "inbox_id": 1,
   "paths": [
 
   ]
@@ -26,12 +30,16 @@
 * `description` (string): Public description
 * `password_protected` (boolean): Is this bundle password protected?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
 * `id` (int64): Bundle ID
 * `created_at` (date-time): Bundle created at date/time
 * `expires_at` (date-time): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
 * `note` (string): Bundle internal note
 * `user_id` (int64): Bundle creator user ID
 * `username` (string): Bundle creator username
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
 * `paths` (array): A list of paths in this bundle
 * `password` (string): Password for this bundle.
 
@@ -79,10 +87,13 @@ Files::Bundle.create(
   paths: ["file.txt"], 
   password: "Password", 
   expires_at: "2000-01-01T01:00:00Z", 
+  max_uses: 1, 
   description: "The public description of the bundle.", 
   note: "The internal note on the bundle.", 
   code: "abc123", 
-  require_registration: true
+  require_registration: true, 
+  clickwrap_id: 1, 
+  inbox_id: 1
 )
 ```
 
@@ -92,10 +103,13 @@ Files::Bundle.create(
 * `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
+* `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
 
 
 ---
@@ -124,10 +138,13 @@ Files::Bundle.share(id,
 Files::Bundle.update(id, 
   password: "Password", 
   expires_at: "2000-01-01T01:00:00Z", 
+  max_uses: 1, 
   description: "The public description of the bundle.", 
   note: "The internal note on the bundle.", 
   code: "abc123", 
-  require_registration: true
+  require_registration: true, 
+  clickwrap_id: 1, 
+  inbox_id: 1
 )
 ```
 
@@ -136,10 +153,13 @@ Files::Bundle.update(id,
 * `id` (int64): Required - Bundle ID.
 * `password` (string): Password for this bundle.
 * `expires_at` (string): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
 
 
 ---
@@ -185,10 +205,13 @@ bundle = Files::Bundle.list_for(path).first
 bundle.update(
   password: "Password",
   expires_at: "2000-01-01T01:00:00Z",
+  max_uses: 1,
   description: "The public description of the bundle.",
   note: "The internal note on the bundle.",
   code: "abc123",
-  require_registration: true
+  require_registration: true,
+  clickwrap_id: 1,
+  inbox_id: 1
 )
 ```
 
@@ -197,10 +220,13 @@ bundle.update(
 * `id` (int64): Required - Bundle ID.
 * `password` (string): Password for this bundle.
 * `expires_at` (string): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
 
 
 ---

data/docs/bundle_download.md

@@ -0,0 +1,35 @@
+# BundleDownload
+
+## Example BundleDownload Object
+
+```
+{
+  "download_method": "file",
+  "path": "a/b/test.txt",
+  "created_at": "2020-01-01 00:00:00"
+}
+```
+
+* `download_method` (string): Download method (file or full_zip)
+* `path` (string): Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `created_at` (date-time): Download date/time
+
+
+---
+
+## List Bundle Downloads
+
+```
+Files::BundleDownload.list(
+  page: 1, 
+  per_page: 1, 
+  bundle_registration_id: 1
+)
+```
+
+### Parameters
+
+* `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.
+* `bundle_registration_id` (int64): Required - BundleRegistration ID

data/docs/clickwrap.md

@@ -0,0 +1,143 @@
+# Clickwrap
+
+## Example Clickwrap Object
+
+```
+{
+  "name": "Example Site NDA for Files.com Use",
+  "body": "[Legal body text]",
+  "use_with_users": "",
+  "use_with_bundles": "",
+  "use_with_inboxes": ""
+}
+```
+
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `id` (int64): Clickwrap ID.
+
+
+---
+
+## List Clickwraps
+
+```
+Files::Clickwrap.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `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.
+
+
+---
+
+## Show Clickwrap
+
+```
+Files::Clickwrap.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+
+
+---
+
+## Create Clickwrap
+
+```
+Files::Clickwrap.create(
+  name: "Example Site NDA for Files.com Use", 
+  body: "[Legal body text]"
+)
+```
+
+### Parameters
+
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+
+
+---
+
+## Update Clickwrap
+
+```
+Files::Clickwrap.update(id, 
+  name: "Example Site NDA for Files.com Use", 
+  body: "[Legal body text]"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+
+
+---
+
+## Delete Clickwrap
+
+```
+Files::Clickwrap.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+
+
+---
+
+## Update Clickwrap
+
+```
+clickwrap = Files::Clickwrap.list_for(path).first
+
+clickwrap.update(
+  name: "Example Site NDA for Files.com Use",
+  body: "[Legal body text]"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+
+
+---
+
+## Delete Clickwrap
+
+```
+clickwrap = Files::Clickwrap.list_for(path).first
+
+clickwrap.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.

data/docs/site.md

@@ -83,6 +83,7 @@
   "session": "",
   "session_pinned_by_ip": true,
   "sftp_user_root_enabled": true,
+  "sharing_enabled": true,
   "show_request_access_link": true,
   "site_footer": "",
   "site_header": "",
@@ -193,6 +194,7 @@
 * `session`: Current session
 * `session_pinned_by_ip` (boolean): Are sessions locked to the same IP? (i.e. do users need to log in again if they change IPs?)
 * `sftp_user_root_enabled` (boolean): Use user FTP roots also for SFTP?
+* `sharing_enabled` (boolean): Allow bundle creation
 * `show_request_access_link` (boolean): Show request access link for users without access?  Currently unused.
 * `site_footer` (string): Custom site footer text
 * `site_header` (string): Custom site header text
@@ -295,6 +297,7 @@ Files::Site.update(
   disable_users_from_inactivity_period_days: 1, 
   non_sso_groups_allowed: true, 
   non_sso_users_allowed: true, 
+  sharing_enabled: true, 
   allowed_2fa_method_sms: true, 
   allowed_2fa_method_u2f: true, 
   allowed_2fa_method_totp: true, 
@@ -385,6 +388,7 @@ Files::Site.update(
 * `disable_users_from_inactivity_period_days` (int64): If greater than zero, users will unable to login if they do not show activity within this number of days.
 * `non_sso_groups_allowed` (boolean): If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
 * `non_sso_users_allowed` (boolean): If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
+* `sharing_enabled` (boolean): Allow bundle creation
 * `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
 * `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
 * `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?

data/docs/user.md

@@ -26,6 +26,7 @@
   "group_ids": [
 
   ],
+  "header_text": "User-specific message.",
   "language": "en",
   "last_login_at": "2000-01-01T01:00:00Z",
   "last_protocol_cipher": "",
@@ -72,6 +73,7 @@
 * `email` (email): User email address
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
 * `group_ids` (array): Comma-separated list of group IDs of which this user is a member
+* `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
 * `last_login_at` (date-time): User's last login time
 * `last_protocol_cipher` (string): The last protocol and cipher used
@@ -169,6 +171,7 @@ Files::User.create(
   dav_permission: true, 
   disabled: true, 
   ftp_permission: true, 
+  header_text: "User-specific message.", 
   language: "en", 
   notification_daily_send_time: 18, 
   name: "John Doe", 
@@ -212,6 +215,7 @@ Files::User.create(
 * `dav_permission` (boolean): Can the user connect with WebDAV?
 * `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
 * `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
 * `name` (string): User's full name
@@ -291,6 +295,7 @@ Files::User.update(id,
   dav_permission: true, 
   disabled: true, 
   ftp_permission: true, 
+  header_text: "User-specific message.", 
   language: "en", 
   notification_daily_send_time: 18, 
   name: "John Doe", 
@@ -335,6 +340,7 @@ Files::User.update(id,
 * `dav_permission` (boolean): Can the user connect with WebDAV?
 * `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
 * `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
 * `name` (string): User's full name
@@ -435,6 +441,7 @@ user.update(
   dav_permission: true,
   disabled: true,
   ftp_permission: true,
+  header_text: "User-specific message.",
   language: "en",
   notification_daily_send_time: 18,
   name: "John Doe",
@@ -479,6 +486,7 @@ user.update(
 * `dav_permission` (boolean): Can the user connect with WebDAV?
 * `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes.  Users can be automatically disabled after an inactivity period via a Site setting.
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
+* `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
 * `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
 * `name` (string): User's full name