files.com 1.0.101 → 1.0.102

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e715ef5d2664eec58ebfa067ff3014018b9f386cfc149a8238e2e9d8bb549331
-  data.tar.gz: d135e40db26bd6c064822453b2999d4f33ea2df40c93096496acc7e4f8db2919
+  metadata.gz: c04971f6d00a131b02f05177190f6ecd61e1e78a85cff414c3a6f1bab9fc1642
+  data.tar.gz: 81edb2e009ebb9ac34454491ae49661951e2ba430043977b4eff5cf1cd27823a
 SHA512:
-  metadata.gz: 5afec2ddef519a7a3c72659adf683d9a2ec227de7bfb511fbe850cda970b25c5055c661bff8ec5a0b42bef24f56a9d91224accc4c9600c885ea21542daacaaff
-  data.tar.gz: 920892400a280447dc341b269e0c48d2f15284e326869ccf4f7a2e64f0a2ed9c3c7a2db356cc40671ad3ce4b3ac0ce7272bc5f0647dffac8ea43229f5f2f0e51
+  metadata.gz: 710b6f10d4ea051a4bfde7be422019d535ee49700fc0816d3f49d5c5a7dc54d579169462ca3eb01bb3819f815d66569815f36284212c27044be9d4f55bae4b09
+  data.tar.gz: 75eb37ba02f5e83e2d9d6ee690ce1b70c8e02c527533caf9ad12bd3e908ea913ffdc8c522cda4268b041820c20b0abbd46ea02af5e1cb81fe2f37a2e76a4043d

data/_VERSION

@@ -1 +1 @@
-1.0.101
+1.0.102

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/lib/files.com.rb

@@ -51,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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.101
+  version: 1.0.102
 platform: ruby
 authors:
 - files.com
@@ -111,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
@@ -174,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