files.com 1.0.166 → 1.0.167

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2da325e9d1150ae1ef34a33f394d1e397750b4d11ebf538ff3ed38a26d896267
-  data.tar.gz: cefd6944825749652aad83230374f957b4fda3c19fa0b63fc1da7976557d6fc6
+  metadata.gz: 3bfca4f729a53761969566b2f3e3a2015529db8c8a0974eaadd956e11aa8a8c9
+  data.tar.gz: f054ddd8f70aca03083f81b0fcc532568e9bd7fec100403d36b3713b342e61dc
 SHA512:
-  metadata.gz: 79a8bac49e15ba046e94bcf1d19f75f55a27ba410fa4acb4006faa7be5354224a4d6368629b923912e7ce78842e33a4b1d9fba096af6340bf15b1d77ded8523c
-  data.tar.gz: 571e00841bbee105c2f6ebdb397409aeb8372faaaa85bb4074eac73985ae6ae5558014b3bcecd77ff52f7f6fae748d5930ef04f1f8f104bc118ecdf73dc2a5d3
+  metadata.gz: c120550e170dbec63173ac48e7026aa951ed5f085c0f14701607dc87ba8eab0e4315d089bea72a75a48a035774956961d0d0fcb3df3dcc79a317c57d74813212
+  data.tar.gz: 312b8a9e7746e2686163c23e98ce445f192e361a3202d6b0fa13e54981e56872cdac76e84bd6aa39e87a20e5e3f79248aa84754f29f1567b0700907c17c12e46

data/_VERSION

@@ -1 +1 @@
-1.0.166
+1.0.167

data/docs/action_notification_export.md

@@ -0,0 +1,82 @@
+# ActionNotificationExport
+
+## Example ActionNotificationExport Object
+
+```
+{
+  "id": 1,
+  "export_version": "20201213.2",
+  "start_at": "2000-01-01T01:00:00Z",
+  "end_at": "2000-01-01T01:00:00Z",
+  "status": "ready",
+  "query_path": "MyFile.txt",
+  "query_folder": "MyFolder",
+  "query_message": "Connection Refused",
+  "query_request_method": "GET",
+  "query_request_url": "http://example.com/webhook",
+  "query_status": "200",
+  "query_success": true,
+  "results_url": "https://files.com/action_notification_results.csv"
+}
+```
+
+* `id` (int64): History Export ID
+* `export_version` (string): Version of the underlying records for the export.
+* `start_at` (date-time): Start date/time of export range.
+* `end_at` (date-time): End date/time of export range.
+* `status` (string): Status of export.  Valid values: `building`, `ready`, or `failed`
+* `query_path` (string): Return notifications that were triggered by actions on this specific path.
+* `query_folder` (string): Return notifications that were triggered by actions in this folder.
+* `query_message` (string): Error message associated with the request, if any.
+* `query_request_method` (string): The HTTP request method used by the webhook.
+* `query_request_url` (string): The target webhook URL.
+* `query_status` (string): The HTTP status returned from the server in response to the webhook request.
+* `query_success` (boolean): true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
+* `results_url` (string): If `status` is `ready`, 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.
+
+
+---
+
+## Show Action Notification Export
+
+```
+Files::ActionNotificationExport.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Action Notification Export ID.
+
+
+---
+
+## Create Action Notification Export
+
+```
+Files::ActionNotificationExport.create(
+  user_id: 1, 
+  start_at: "2000-01-01T01:00:00Z", 
+  end_at: "2000-01-01T01:00:00Z", 
+  query_message: "Connection Refused", 
+  query_request_method: "GET", 
+  query_request_url: "http://example.com/webhook", 
+  query_status: "200", 
+  query_success: true, 
+  query_path: "MyFile.txt", 
+  query_folder: "MyFolder"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `start_at` (string): Start date/time of export range.
+* `end_at` (string): End date/time of export range.
+* `query_message` (string): Error message associated with the request, if any.
+* `query_request_method` (string): The HTTP request method used by the webhook.
+* `query_request_url` (string): The target webhook URL.
+* `query_status` (string): The HTTP status returned from the server in response to the webhook request.
+* `query_success` (boolean): true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
+* `query_path` (string): Return notifications that were triggered by actions on this specific path.
+* `query_folder` (string): Return notifications that were triggered by actions in this folder.

data/docs/action_notification_export_result.md

@@ -0,0 +1,49 @@
+# ActionNotificationExportResult
+
+## Example ActionNotificationExportResult Object
+
+```
+{
+  "id": 1,
+  "created_at": 1,
+  "status": 200,
+  "message": "Success",
+  "success": true,
+  "request_headers": "{\"User-Agent\":\"Files.com Webhook\"}",
+  "request_method": "GET",
+  "request_url": "www.example.com/webhook_receiver",
+  "path": "MyFolder/MyFile.txt",
+  "folder": "MyFolder"
+}
+```
+
+* `id` (int64): Notification ID
+* `created_at` (int64): When the notification was sent.
+* `status` (int64): HTTP status code returned in the webhook response.
+* `message` (string): A message indicating the overall status of the webhook notification.
+* `success` (boolean): `true` if the webhook succeeded by receiving a 200 or 204 response.
+* `request_headers` (string): A JSON-encoded string with headers that were sent with the webhook.
+* `request_method` (string): The HTTP verb used to perform the webhook.
+* `request_url` (string): The webhook request URL.
+* `path` (string): The path to the actual file that triggered this notification. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `folder` (string): The folder associated with the triggering action for this notification.
+
+
+---
+
+## List Action Notification Export Results
+
+```
+Files::ActionNotificationExportResult.list(
+  user_id: 1, 
+  per_page: 1, 
+  action_notification_export_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `cursor` (string): Used for pagination.  Send a cursor value 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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action_notification_export_id` (int64): Required - ID of the associated action notification export.

data/docs/history_export.md

@@ -56,7 +56,7 @@
 * `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.
+* `results_url` (string): If `status` is `ready`, 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.
 
 

data/lib/files.com.rb

@@ -29,6 +29,8 @@ require "files.com/uri"
 
 require "files.com/models/account_line_item"
 require "files.com/models/action"
+require "files.com/models/action_notification_export"
+require "files.com/models/action_notification_export_result"
 require "files.com/models/api_key"
 require "files.com/models/app"
 require "files.com/models/as2_key"

data/lib/files.com/errors.rb

@@ -118,11 +118,11 @@ module Files
   class ContactAdminForPasswordChangeHelpError < NotAuthorizedError; end
   class FolderAdminOrBillingPermissionRequiredError < NotAuthorizedError; end
   class FolderAdminPermissionRequiredError < NotAuthorizedError; end
-  class HistoryExportNonAdminsMustQueryByFolderOrPathError < NotAuthorizedError; end
   class HistoryPermissionRequiredError < NotAuthorizedError; end
   class InsufficientPermissionForParamsError < NotAuthorizedError; end
   class MustAuthenticateWithApiKeyError < NotAuthorizedError; end
   class NeedAdminPermissionForInboxError < NotAuthorizedError; end
+  class NonAdminsMustQueryByFolderOrPathError < NotAuthorizedError; end
   class NotAllowedToCreateBundleError < NotAuthorizedError; end
   class PasswordChangeNotRequiredError < NotAuthorizedError; end
   class PasswordChangeRequiredError < NotAuthorizedError; end
@@ -158,6 +158,8 @@ module Files
   class DestinationParentConflictError < ProcessingFailureError; end
   class DestinationParentDoesNotExistError < ProcessingFailureError; end
   class ExpiredPublicKeyError < ProcessingFailureError; end
+  class ExportFailureError < ProcessingFailureError; end
+  class ExportNotReadyError < ProcessingFailureError; end
   class FailedToChangePasswordError < ProcessingFailureError; end
   class FileLockedError < ProcessingFailureError; end
   class FileNotUploadedError < ProcessingFailureError; end
@@ -165,8 +167,6 @@ module Files
   class FileUploadedToWrongRegionError < ProcessingFailureError; end
   class FolderLockedError < ProcessingFailureError; end
   class FolderNotEmptyError < ProcessingFailureError; end
-  class HistoryExportFailureError < ProcessingFailureError; end
-  class HistoryExportNotReadyError < ProcessingFailureError; end
   class HistoryUnavailableError < ProcessingFailureError; end
   class InvalidBundleCodeError < ProcessingFailureError; end
   class InvalidFileTypeError < ProcessingFailureError; end

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

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module Files
+  class ActionNotificationExport
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - History Export ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Version of the underlying records for the export.
+    def export_version
+      @attributes[:export_version]
+    end
+
+    def export_version=(value)
+      @attributes[:export_version] = value
+    end
+
+    # date-time - Start date/time of export range.
+    def start_at
+      @attributes[:start_at]
+    end
+
+    def start_at=(value)
+      @attributes[:start_at] = value
+    end
+
+    # date-time - End date/time of export range.
+    def end_at
+      @attributes[:end_at]
+    end
+
+    def end_at=(value)
+      @attributes[:end_at] = value
+    end
+
+    # string - Status of export.  Valid values: `building`, `ready`, or `failed`
+    def status
+      @attributes[:status]
+    end
+
+    def status=(value)
+      @attributes[:status] = value
+    end
+
+    # string - Return notifications that were triggered by actions on this specific path.
+    def query_path
+      @attributes[:query_path]
+    end
+
+    def query_path=(value)
+      @attributes[:query_path] = value
+    end
+
+    # string - Return notifications that were triggered by actions in this folder.
+    def query_folder
+      @attributes[:query_folder]
+    end
+
+    def query_folder=(value)
+      @attributes[:query_folder] = value
+    end
+
+    # string - Error message associated with the request, if any.
+    def query_message
+      @attributes[:query_message]
+    end
+
+    def query_message=(value)
+      @attributes[:query_message] = value
+    end
+
+    # string - The HTTP request method used by the webhook.
+    def query_request_method
+      @attributes[:query_request_method]
+    end
+
+    def query_request_method=(value)
+      @attributes[:query_request_method] = value
+    end
+
+    # string - The target webhook URL.
+    def query_request_url
+      @attributes[:query_request_url]
+    end
+
+    def query_request_url=(value)
+      @attributes[:query_request_url] = value
+    end
+
+    # string - The HTTP status returned from the server in response to the webhook request.
+    def query_status
+      @attributes[:query_status]
+    end
+
+    def query_status=(value)
+      @attributes[:query_status] = value
+    end
+
+    # boolean - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
+    def query_success
+      @attributes[:query_success]
+    end
+
+    def query_success=(value)
+      @attributes[:query_success] = value
+    end
+
+    # string - If `status` is `ready`, 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]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The ActionNotificationExport object doesn't support updates.")
+      else
+        new_obj = ActionNotificationExport.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Action Notification Export ID.
+    def self.find(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("/action_notification_exports/#{params[:id]}", :get, params, options)
+      ActionNotificationExport.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   start_at - string - Start date/time of export range.
+    #   end_at - string - End date/time of export range.
+    #   query_message - string - Error message associated with the request, if any.
+    #   query_request_method - string - The HTTP request method used by the webhook.
+    #   query_request_url - string - The target webhook URL.
+    #   query_status - string - The HTTP status returned from the server in response to the webhook request.
+    #   query_success - boolean - true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
+    #   query_path - string - Return notifications that were triggered by actions on this specific path.
+    #   query_folder - string - Return notifications that were triggered by actions in this folder.
+    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: start_at must be an String") if params.dig(:start_at) and !params.dig(:start_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: end_at must be an String") if params.dig(:end_at) and !params.dig(:end_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: query_message must be an String") if params.dig(:query_message) and !params.dig(:query_message).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: query_request_method must be an String") if params.dig(:query_request_method) and !params.dig(:query_request_method).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: query_request_url must be an String") if params.dig(:query_request_url) and !params.dig(:query_request_url).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: query_status must be an String") if params.dig(:query_status) and !params.dig(:query_status).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: query_path must be an String") if params.dig(:query_path) and !params.dig(:query_path).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: query_folder must be an String") if params.dig(:query_folder) and !params.dig(:query_folder).is_a?(String)
+
+      response, options = Api.send_request("/action_notification_exports", :post, params, options)
+      ActionNotificationExport.new(response.data, options)
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Files
+  class ActionNotificationExportResult
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Notification ID
+    def id
+      @attributes[:id]
+    end
+
+    # int64 - When the notification was sent.
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # int64 - HTTP status code returned in the webhook response.
+    def status
+      @attributes[:status]
+    end
+
+    # string - A message indicating the overall status of the webhook notification.
+    def message
+      @attributes[:message]
+    end
+
+    # boolean - `true` if the webhook succeeded by receiving a 200 or 204 response.
+    def success
+      @attributes[:success]
+    end
+
+    # string - A JSON-encoded string with headers that were sent with the webhook.
+    def request_headers
+      @attributes[:request_headers]
+    end
+
+    # string - The HTTP verb used to perform the webhook.
+    def request_method
+      @attributes[:request_method]
+    end
+
+    # string - The webhook request URL.
+    def request_url
+      @attributes[:request_url]
+    end
+
+    # string - The path to the actual file that triggered this notification. 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 - The folder associated with the triggering action for this notification.
+    def folder
+      @attributes[:folder]
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   cursor - string - Used for pagination.  Send a cursor value 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.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   action_notification_export_id (required) - int64 - ID of the associated action notification 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: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
+      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_notification_export_id must be an Integer") if params.dig(:action_notification_export_id) and !params.dig(:action_notification_export_id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: action_notification_export_id") unless params.dig(:action_notification_export_id)
+
+      List.new(ActionNotificationExportResult, params) do
+        Api.send_request("/action_notification_export_results", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

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

@@ -225,7 +225,7 @@ 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.
+    # string - If `status` is `ready`, this will be a URL where all the results can be downloaded at once as a CSV.
     def results_url
       @attributes[:results_url]
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.166
+  version: 1.0.167
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-23 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -88,6 +88,8 @@ files:
 - build.sh
 - docs/account_line_item.md
 - docs/action.md
+- docs/action_notification_export.md
+- docs/action_notification_export_result.md
 - docs/api_key.md
 - docs/app.md
 - docs/as2_key.md
@@ -160,6 +162,8 @@ files:
 - lib/files.com/list.rb
 - lib/files.com/models/account_line_item.rb
 - lib/files.com/models/action.rb
+- lib/files.com/models/action_notification_export.rb
+- lib/files.com/models/action_notification_export_result.rb
 - lib/files.com/models/api_key.rb
 - lib/files.com/models/app.rb
 - lib/files.com/models/as2_key.rb