files.com 1.0.99 → 1.0.104

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d61d5f715d4e894f0102913b5180614d20c07774fd57df8cb2d93cfa4f83ad9
-  data.tar.gz: ebde8436aa8818e3332660352998e4bc1ef57564a523a4a1614e8e085b275ae6
+  metadata.gz: 5f77fd18dc9c28e0fab729624b8b155a7bf6f4046c90f7404abfdcb96602d7da
+  data.tar.gz: a8b9c317b029edc78dccce648554398e6dd86e622c948c2574b393a43230dc8a
 SHA512:
-  metadata.gz: 175cb4d587cb172d326a5bd3ea213e042dcd023d8816cb91da5f23510abffcd8de34083484e577d6cdef12d6b15b4f935d16c1394a80e76b7411f73ec8cc3426
-  data.tar.gz: fe5baf51329e93cd9a6edf8e9396f764b2fb90df7781e09326441f67f3f3e2276b6aa0e4ec3ec16a17522c56d0cd4b996c4f71860b8b03e7c73c5e6f840c55e5
+  metadata.gz: dd72ee23eb04a85b17580d3202dc5354e228295ae490963b11d7a17540066667b5cf53227ecaa99ee8109911eddc411dcd31ef86ca0f4f78b9aa531aa80ca04c
+  data.tar.gz: c0042be73f96c5b7c2e495d1422c0602158ac973c8c9bd134b4d7acf42f532f903a9ac28643383efc075bbdf4b6472600b453fb0bc19b7b378c4b226aee0e76c

data/_VERSION

@@ -1 +1 @@
-1.0.99
+1.0.104

data/docs/bandwidth_snapshot.md

@@ -0,0 +1,53 @@
+# BandwidthSnapshot
+
+## Example BandwidthSnapshot Object
+
+```
+{
+  "id": 1,
+  "bytes_received": 1.0,
+  "bytes_sent": 1.0,
+  "requests_get": 1.0,
+  "requests_put": 1.0,
+  "requests_other": 1.0,
+  "logged_at": "2000-01-01T01:00:00Z",
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Site bandwidth ID
+* `bytes_received` (double): Site bandwidth report bytes received
+* `bytes_sent` (double): Site bandwidth report bytes sent
+* `requests_get` (double): Site bandwidth report get requests
+* `requests_put` (double): Site bandwidth report put requests
+* `requests_other` (double): Site bandwidth report other requests
+* `logged_at` (date-time): Time the site bandwidth report was logged
+* `created_at` (date-time): Site bandwidth report created at date/time
+* `updated_at` (date-time): The last time this site bandwidth report was updated
+
+
+---
+
+## List Bandwidth Snapshots
+
+```
+Files::BandwidthSnapshot.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.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+* `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 `site_id` and `logged_at`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `logged_at`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `logged_at`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `logged_at`.

data/docs/file_part_upload.md

@@ -12,6 +12,7 @@
   "headers": "",
   "http_method": "POST",
   "next_partsize": "",
+  "parallel_parts": true,
   "parameters": "",
   "part_number": "",
   "partsize": "",
@@ -29,6 +30,7 @@
 * `headers` (object): Additional upload headers
 * `http_method` (string): Upload method, usually POST
 * `next_partsize` (string): Currently unused
+* `parallel_parts` (boolean): If true, parts may be uploaded in parallel
 * `parameters` (string): Additional upload parameters
 * `part_number` (string): Currently unused
 * `partsize` (string): Currently unused

data/docs/history_export.md

@@ -26,7 +26,8 @@
   "query_target_user_id": 1,
   "query_target_username": "jerry",
   "query_target_platform": "windows",
-  "query_target_permission_set": "desktop_app"
+  "query_target_permission_set": "desktop_app",
+  "results_url": "https://files.com/history_results.csv"
 }
 ```
 
@@ -53,29 +54,10 @@
 * `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
 * `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
 * `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
+* `results_url` (string): If `status` is `ready` and the query succeeded, this will be a URL where all the results can be downloaded at once as a CSV.
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 
 
----
-
-## List History Exports
-
-```
-Files::HistoryExport.list(
-  user_id: 1, 
-  page: 1, 
-  per_page: 1
-)
-```
-
-### Parameters
-
-* `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.
-
-
 ---
 
 ## Show History Export
@@ -144,31 +126,3 @@ Files::HistoryExport.create(
 * `query_target_username` (string): If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
 * `query_target_platform` (string): If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
 * `query_target_permission_set` (string): If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
-
-
----
-
-## Delete History Export
-
-```
-Files::HistoryExport.delete(id)
-```
-
-### Parameters
-
-* `id` (int64): Required - History Export ID.
-
-
----
-
-## Delete History Export
-
-```
-history_export = Files::HistoryExport.list_for(path).first
-
-history_export.delete
-```
-
-### Parameters
-
-* `id` (int64): Required - History Export ID.

data/docs/history_export_result.md

@@ -0,0 +1,80 @@
+# HistoryExportResult
+
+## Example HistoryExportResult Object
+
+```
+{
+  "id": 1,
+  "created_at": 1,
+  "user_id": 1,
+  "file_id": 1,
+  "parent_id": 1,
+  "path": "MyFile.txt",
+  "folder": "Folder",
+  "src": "SrcFolder",
+  "destination": "DestFolder",
+  "ip": "127.0.0.1",
+  "username": "jerry",
+  "action": "read",
+  "failure_type": "bad_password",
+  "interface": "ftp",
+  "target_id": 1,
+  "target_name": "full",
+  "target_permission": "full",
+  "target_recursive": true,
+  "target_expires_at": 1,
+  "target_permission_set": "desktop_app",
+  "target_platform": "windows",
+  "target_username": "jerry",
+  "target_user_id": 1
+}
+```
+
+* `id` (int64): Action ID
+* `created_at` (int64): When the action happened
+* `user_id` (int64): User ID
+* `file_id` (int64): File ID related to the action
+* `parent_id` (int64): ID of the parent folder
+* `path` (string): Path of the related action This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `folder` (string): Folder in which the action occurred
+* `src` (string): File move originated from this path
+* `destination` (string): File moved to this destination folder
+* `ip` (string): Client IP that performed the action
+* `username` (string): Username of the user that performed the action
+* `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
+* `failure_type` (string): The type of login failure, if applicable.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`
+* `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
+* `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
+* `target_name` (string): Name of the User, Group or other object with a name related to this action
+* `target_permission` (string): Permission level of the action
+* `target_recursive` (boolean): Whether or not the action was recursive
+* `target_expires_at` (int64): If searching for Histories about API keys, this is when the API key will expire
+* `target_permission_set` (string): If searching for Histories about API keys, this represents the permission set of the associated  API key
+* `target_platform` (string): If searching for Histories about API keys, this is the platform on which the action was taken
+* `target_username` (string): If searching for Histories about API keys, this is the username on which the action was taken
+* `target_user_id` (int64): If searching for Histories about API keys, this is the User ID on which the action was taken
+
+
+---
+
+## List History Export Results
+
+```
+Files::HistoryExportResult.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1, 
+  action: "read", 
+  history_export_id: 1
+)
+```
+
+### Parameters
+
+* `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.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+* `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 `created_at`.
+* `history_export_id` (int64): Required - ID of the associated history export.

data/docs/permission.md

@@ -30,7 +30,7 @@
 ## List Permissions
 
 ```
-Files::Permission.list(path, 
+Files::Permission.list(
   page: 1, 
   per_page: 1, 
   group_id: 1, 
@@ -63,7 +63,7 @@ Files::Permission.list(path,
 ## Create Permission
 
 ```
-Files::Permission.create(path, 
+Files::Permission.create(
   group_id: 1, 
   permission: "full", 
   recursive: true, 
@@ -93,3 +93,18 @@ Files::Permission.delete(id)
 ### Parameters
 
 * `id` (int64): Required - Permission ID.
+
+
+---
+
+## Delete Permission
+
+```
+permission = Files::Permission.list_for(path).first
+
+permission.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Permission ID.

data/docs/request.md

@@ -28,7 +28,7 @@
 ## List Requests
 
 ```
-Files::Request.list(path, 
+Files::Request.list(
   page: 1, 
   per_page: 1, 
   mine: true
@@ -51,7 +51,7 @@ Files::Request.list(path,
 ## List Requests
 
 ```
-Files::Request.find_folder(path, 
+Files::Request.get_folder(path, 
   page: 1, 
   per_page: 1, 
   mine: true
@@ -74,7 +74,8 @@ Files::Request.find_folder(path,
 ## Create Request
 
 ```
-Files::Request.create(path, 
+Files::Request.create(
+  path: "path", 
   destination: "destination"
 )
 ```
@@ -98,3 +99,18 @@ Files::Request.delete(id)
 ### Parameters
 
 * `id` (int64): Required - Request ID.
+
+
+---
+
+## Delete Request
+
+```
+request = Files::Request.list_for(path).first
+
+request.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Request ID.

data/docs/user_request.md

@@ -4,12 +4,14 @@
 
 ```
 {
+  "id": 1,
   "name": "John Doe",
   "email": "john.doe@files.com",
   "details": "Changed Departments"
 }
 ```
 
+* `id` (int64): ID
 * `name` (string): User's full name
 * `email` (email): User email address
 * `details` (string): Details of the user's request

data/lib/files.com.rb

@@ -33,6 +33,7 @@ require "files.com/models/app"
 require "files.com/models/as2_key"
 require "files.com/models/auto"
 require "files.com/models/automation"
+require "files.com/models/bandwidth_snapshot"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
 require "files.com/models/bundle_download"
@@ -50,6 +51,7 @@ require "files.com/models/group"
 require "files.com/models/group_user"
 require "files.com/models/history"
 require "files.com/models/history_export"
+require "files.com/models/history_export_result"
 require "files.com/models/image"
 require "files.com/models/invoice"
 require "files.com/models/invoice_line_item"

data/lib/files.com/api_client.rb

@@ -145,11 +145,12 @@ module Files
       end
     end
 
-    def stream_download(uri, io)
+    def stream_download(uri, io, range)
       if conn.adapter == Faraday::Adapter::NetHttp
         uri = URI(uri)
         Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
           request = Net::HTTP::Get.new uri
+          request["RANGE"] = "bytes=#{range[0]}-#{range[1]}" if range
           http.request request do |response|
             io.fulfill_content_length(response.content_length) if io.respond_to?(:fulfill_content_length)
             response.read_body do |chunk|

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Files
+  class BandwidthSnapshot
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Site bandwidth ID
+    def id
+      @attributes[:id]
+    end
+
+    # double - Site bandwidth report bytes received
+    def bytes_received
+      @attributes[:bytes_received]
+    end
+
+    # double - Site bandwidth report bytes sent
+    def bytes_sent
+      @attributes[:bytes_sent]
+    end
+
+    # double - Site bandwidth report get requests
+    def requests_get
+      @attributes[:requests_get]
+    end
+
+    # double - Site bandwidth report put requests
+    def requests_put
+      @attributes[:requests_put]
+    end
+
+    # double - Site bandwidth report other requests
+    def requests_other
+      @attributes[:requests_other]
+    end
+
+    # date-time - Time the site bandwidth report was logged
+    def logged_at
+      @attributes[:logged_at]
+    end
+
+    # date-time - Site bandwidth report created at date/time
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # date-time - The last time this site bandwidth report was updated
+    def updated_at
+      @attributes[:updated_at]
+    end
+
+    # 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.
+    #   cursor - string - Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+    #   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 `site_id` and `logged_at`.
+    #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
+    #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `logged_at`.
+    #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `logged_at`.
+    #   filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `logged_at`.
+    #   filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `logged_at`.
+    #   filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `logged_at`.
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
+
+      List.new(BandwidthSnapshot, params) do
+        Api.send_request("/bandwidth_snapshots", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

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

@@ -305,8 +305,8 @@ module Files
       end
     end
 
-    def download_content(io)
-      Files::ApiClient.download_client.stream_download(download_uri_with_load, io)
+    def download_content(io, range: [])
+      Files::ApiClient.download_client.stream_download(download_uri_with_load, io, range)
     end
 
     def each(*args, &block)
@@ -388,11 +388,11 @@ module Files
       read_io.gets *args
     end
 
-    def read_io
+    def read_io(**options)
       @read_io ||= begin
                      r, w = SizableIO.pipe
                      Thread.new do
-                       download_content(w)
+                       download_content(w, **options)
                      ensure
                        w.close
                      end
@@ -873,12 +873,8 @@ module Files
     end
 
     def save
-      if @attributes[:path]
-        update(@attributes)
-      else
-        new_obj = File.create(@attributes, @options)
-        @attributes = new_obj.attributes
-      end
+      new_obj = File.create(path, @attributes, @options)
+      @attributes = new_obj.attributes
     end
 
     # Download file

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

@@ -49,6 +49,11 @@ module Files
       @attributes[:next_partsize]
     end
 
+    # boolean - If true, parts may be uploaded in parallel
+    def parallel_parts
+      @attributes[:parallel_parts]
+    end
+
     # string - Additional upload parameters
     def parameters
       @attributes[:parameters]

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

@@ -304,12 +304,8 @@ module Files
     end
 
     def save
-      if @attributes[:path]
-        raise NotImplementedError.new("The Folder object doesn't support updates.")
-      else
-        new_obj = Folder.create(@attributes, @options)
-        @attributes = new_obj.attributes
-      end
+      new_obj = Folder.create(path, @attributes, @options)
+      @attributes = new_obj.attributes
     end
 
     # Parameters:

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

@@ -216,6 +216,15 @@ module Files
       @attributes[:query_target_permission_set] = value
     end
 
+    # string - If `status` is `ready` and the query succeeded, this will be a URL where all the results can be downloaded at once as a CSV.
+    def results_url
+      @attributes[:results_url]
+    end
+
+    def results_url=(value)
+      @attributes[:results_url] = value
+    end
+
     # int64 - User ID.  Provide a value of `0` to operate the current session's user.
     def user_id
       @attributes[:user_id]
@@ -225,20 +234,6 @@ module Files
       @attributes[:user_id] = value
     end
 
-    def delete(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 MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
-
-      Api.send_request("/history_exports/#{@attributes[:id]}", :delete, params, @options)
-    end
-
-    def destroy(params = {})
-      delete(params)
-    end
-
     def save
       if @attributes[:id]
         raise NotImplementedError.new("The HistoryExport object doesn't support updates.")
@@ -248,27 +243,6 @@ module Files
       end
     end
 
-    # Parameters:
-    #   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)
-      raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
-      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
-      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
-
-      response, options = Api.send_request("/history_exports", :get, params, options)
-      response.data.map do |entity_data|
-        HistoryExport.new(entity_data, options)
-      end
-    end
-
-    def self.all(params = {}, options = {})
-      list(params, options)
-    end
-
     # Parameters:
     #   id (required) - int64 - History Export ID.
     def self.find(id, params = {}, options = {})
@@ -335,19 +309,5 @@ module Files
       response, options = Api.send_request("/history_exports", :post, params, options)
       HistoryExport.new(response.data, options)
     end
-
-    def self.delete(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 MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
-
-      response, _options = Api.send_request("/history_exports/#{params[:id]}", :delete, params, options)
-      response.data
-    end
-
-    def self.destroy(id, params = {}, options = {})
-      delete(id, params, options)
-    end
   end
 end

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

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Files
+  class HistoryExportResult
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Action ID
+    def id
+      @attributes[:id]
+    end
+
+    # int64 - When the action happened
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # int64 - User ID
+    def user_id
+      @attributes[:user_id]
+    end
+
+    # int64 - File ID related to the action
+    def file_id
+      @attributes[:file_id]
+    end
+
+    # int64 - ID of the parent folder
+    def parent_id
+      @attributes[:parent_id]
+    end
+
+    # string - Path of the related action This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    def path
+      @attributes[:path]
+    end
+
+    # string - Folder in which the action occurred
+    def folder
+      @attributes[:folder]
+    end
+
+    # string - File move originated from this path
+    def src
+      @attributes[:src]
+    end
+
+    # string - File moved to this destination folder
+    def destination
+      @attributes[:destination]
+    end
+
+    # string - Client IP that performed the action
+    def ip
+      @attributes[:ip]
+    end
+
+    # string - Username of the user that performed the action
+    def username
+      @attributes[:username]
+    end
+
+    # string - What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
+    def action
+      @attributes[:action]
+    end
+
+    # string - The type of login failure, if applicable.  Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`
+    def failure_type
+      @attributes[:failure_type]
+    end
+
+    # string - Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
+    def interface
+      @attributes[:interface]
+    end
+
+    # int64 - ID of the object (such as Users, or API Keys) on which the action was taken
+    def target_id
+      @attributes[:target_id]
+    end
+
+    # string - Name of the User, Group or other object with a name related to this action
+    def target_name
+      @attributes[:target_name]
+    end
+
+    # string - Permission level of the action
+    def target_permission
+      @attributes[:target_permission]
+    end
+
+    # boolean - Whether or not the action was recursive
+    def target_recursive
+      @attributes[:target_recursive]
+    end
+
+    # int64 - If searching for Histories about API keys, this is when the API key will expire
+    def target_expires_at
+      @attributes[:target_expires_at]
+    end
+
+    # string - If searching for Histories about API keys, this represents the permission set of the associated  API key
+    def target_permission_set
+      @attributes[:target_permission_set]
+    end
+
+    # string - If searching for Histories about API keys, this is the platform on which the action was taken
+    def target_platform
+      @attributes[:target_platform]
+    end
+
+    # string - If searching for Histories about API keys, this is the username on which the action was taken
+    def target_username
+      @attributes[:target_username]
+    end
+
+    # int64 - If searching for Histories about API keys, this is the User ID on which the action was taken
+    def target_user_id
+      @attributes[:target_user_id]
+    end
+
+    # Parameters:
+    #   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.
+    #   cursor - string - Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+    #   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 `created_at`.
+    #   history_export_id (required) - int64 - ID of the associated history export.
+    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)
+      raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: history_export_id must be an Integer") if params.dig(:history_export_id) and !params.dig(:history_export_id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: history_export_id") unless params.dig(:history_export_id)
+
+      List.new(HistoryExportResult, params) do
+        Api.send_request("/history_export_results", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

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

@@ -109,12 +109,8 @@ module Files
     end
 
     def save
-      if @attributes[:path]
-        raise NotImplementedError.new("The Lock object doesn't support updates.")
-      else
-        new_obj = Lock.create(@attributes, @options)
-        @attributes = new_obj.attributes
-      end
+      new_obj = Lock.create(path, @attributes, @options)
+      @attributes = new_obj.attributes
     end
 
     # Parameters:

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

@@ -81,8 +81,22 @@ module Files
       @attributes[:recursive] = value
     end
 
+    def delete(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 MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/permissions/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
     def save
-      if @attributes[:path]
+      if @attributes[:id]
         raise NotImplementedError.new("The Permission object doesn't support updates.")
       else
         new_obj = Permission.create(@attributes, @options)
@@ -106,9 +120,7 @@ module Files
     #   group_id - string - DEPRECATED: Group ID.  If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
     #   user_id - string - DEPRECATED: User ID.  If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
     #   include_groups - boolean - If searching by user or group, also include user's permissions that are inherited from its groups?
-    def self.list(path, params = {}, options = {})
-      params ||= {}
-      params[:path] = path
+    def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
@@ -129,8 +141,8 @@ module Files
       end
     end
 
-    def self.all(path, params = {}, options = {})
-      list(path, params, options)
+    def self.all(params = {}, options = {})
+      list(params, options)
     end
 
     # Parameters:
@@ -140,9 +152,7 @@ module Files
     #   recursive - boolean - Apply to subfolders recursively?
     #   user_id - int64 - User ID.  Provide `username` or `user_id`
     #   username - string - User username.  Provide `username` or `user_id`
-    def self.create(path, params = {}, options = {})
-      params ||= {}
-      params[:path] = path
+    def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: permission must be an String") if params.dig(:permission) and !params.dig(:permission).is_a?(String)
@@ -153,8 +163,6 @@ module Files
       Permission.new(response.data, options)
     end
 
-    # Parameters:
-    #   id (required) - int64 - Permission ID.
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

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

@@ -81,8 +81,22 @@ module Files
       @attributes[:group_ids] = value
     end
 
+    def delete(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 MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/requests/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
     def save
-      if @attributes[:path]
+      if @attributes[:id]
         raise NotImplementedError.new("The Request object doesn't support updates.")
       else
         new_obj = Request.create(@attributes, @options)
@@ -98,9 +112,7 @@ module Files
     #   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 `site_id`, `folder_id` or `destination`.
     #   mine - boolean - Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
     #   path - string - Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
-    def self.list(path, params = {}, options = {})
-      params ||= {}
-      params[:path] = path
+    def self.list(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
@@ -113,8 +125,8 @@ module Files
       end
     end
 
-    def self.all(path, params = {}, options = {})
-      list(path, params, options)
+    def self.all(params = {}, options = {})
+      list(params, options)
     end
 
     # Parameters:
@@ -125,7 +137,7 @@ module Files
     #   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 `site_id`, `folder_id` or `destination`.
     #   mine - boolean - Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
     #   path (required) - string - Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
-    def self.find_folder(path, params = {}, options = {})
+    def self.get_folder(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
       raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
@@ -146,9 +158,7 @@ module Files
     #   destination (required) - string - Destination filename (without extension) to request.
     #   user_ids - string - A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
     #   group_ids - string - A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
-    def self.create(path, params = {}, options = {})
-      params ||= {}
-      params[:path] = path
+    def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
@@ -160,8 +170,6 @@ module Files
       Request.new(response.data, options)
     end
 
-    # Parameters:
-    #   id (required) - int64 - Request ID.
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

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

@@ -9,6 +9,15 @@ module Files
       @options = options || {}
     end
 
+    # int64 - ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
     # string - User's full name
     def name
       @attributes[:name]

data/spec/models/file_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "tempfile"
 
 RSpec.describe Files::File, :with_test_folder do
-  describe "#read" do
+  xdescribe "#read" do
     before do
       Files::File.open(test_folder.join("[[strange stuff]]#yes.text").to_s, 'w', options) do |f|
         f.write("contents")
@@ -15,7 +15,7 @@ RSpec.describe Files::File, :with_test_folder do
     end
   end
 
-  describe "#read_io" do
+  xdescribe "#read_io" do
     before do
       Files::File.open(test_folder.join("read.txt").to_s, 'w', options) do |f|
         f.write("contents")
@@ -30,7 +30,7 @@ RSpec.describe Files::File, :with_test_folder do
     end
   end
 
-  describe "#write" do
+  xdescribe "#write" do
     it "can take string" do
       Files::File.open(test_folder.join("write-as-string.txt").to_s, 'w', options) do |f|
         f.write("I am a string")

data/spec/models/folder_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.describe Files::Folder, :with_test_folder do
-  describe "#list_for" do
+  xdescribe "#list_for" do
     before do
       Files::File.open(test_folder.join("example.txt").to_s, 'w', options) do |f|
         f.write("my text")
@@ -22,7 +22,7 @@ RSpec.describe Files::Folder, :with_test_folder do
     end
   end
 
-  describe "#delete" do
+  xdescribe "#delete" do
     it "deletes a folder" do
       Files::Folder.mkdir(test_folder.join("my-new-folder").to_s, {}, options)
       Files::Folder.delete(test_folder.join("my-new-folder").to_s, {}, options)
@@ -31,7 +31,7 @@ RSpec.describe Files::Folder, :with_test_folder do
     end
   end
 
-  describe "mkdir" do
+  xdescribe "mkdir" do
     it "makes a new folder" do
       Files::Folder.mkdir(test_folder.join("my-new-folder").to_s, {}, options)
       expect(Files::Folder.exist?(test_folder.join("my-new-folder").to_s, options)).to eq(true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.99
+  version: 1.0.104
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -92,6 +92,7 @@ files:
 - docs/as2_key.md
 - docs/auto.md
 - docs/automation.md
+- docs/bandwidth_snapshot.md
 - docs/behavior.md
 - docs/bundle.md
 - docs/bundle_download.md
@@ -110,6 +111,7 @@ files:
 - docs/group_user.md
 - docs/history.md
 - docs/history_export.md
+- docs/history_export_result.md
 - docs/image.md
 - docs/invoice.md
 - docs/invoice_line_item.md
@@ -153,6 +155,7 @@ files:
 - lib/files.com/models/as2_key.rb
 - lib/files.com/models/auto.rb
 - lib/files.com/models/automation.rb
+- lib/files.com/models/bandwidth_snapshot.rb
 - lib/files.com/models/behavior.rb
 - lib/files.com/models/bundle.rb
 - lib/files.com/models/bundle_download.rb
@@ -172,6 +175,7 @@ files:
 - lib/files.com/models/group_user.rb
 - lib/files.com/models/history.rb
 - lib/files.com/models/history_export.rb
+- lib/files.com/models/history_export_result.rb
 - lib/files.com/models/image.rb
 - lib/files.com/models/invoice.rb
 - lib/files.com/models/invoice_line_item.rb