files.com 1.1.172 → 1.1.173

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8df37806e5e558cb102955bcc602c345a19c4114ef43e62f2c0275044b07011
-  data.tar.gz: bb42bc3487b4e403a99ad3d2b9ef7d660a20bd775f2952f34cae779114446e70
+  metadata.gz: 4c4a2e877be12c7f43fb6330174363be7e753cea739d8ea4939176ed620d9248
+  data.tar.gz: 9336e3cde8025506b74a34c2ca4df1aea3131f2ed77362c6d066d1f1b356a494
 SHA512:
-  metadata.gz: 4cf6c501b535d63a8d90ff9633ec555efe729b97db1d48e5fca5b17feda8272d345d93c9d79ce91b604d61d6d7abff3f189259b30dc233b2fb8fc47ab672c43d
-  data.tar.gz: 0b123b00603973aaf8bfd119b102ba5c835f7bfd7447660b8ab9aa5d23593c49ff89d3c45eb229016429aee588899ff9551f6fb853ccb073430b438e2424aca6
+  metadata.gz: 26e6ab7e1e869626b11199e672bccb526d0e9f6b245ac3b152149d0e266d4beb71c2914a1dda360cca6b8f97e08549b5aa64247ed90f0ae6452d16ed07543fdd
+  data.tar.gz: fa0a3374c0971d9c9920395c75f7703eed027df66450d39ec1b510e3f97ea7d5d25a8c5f04ed759a476e4f55fd1893e39136a730cc534dbbbccaf227e09f0460

data/_VERSION

@@ -1 +1 @@
-1.1.172
+1.1.173

data/docs/bundle_action.md

@@ -49,7 +49,7 @@ Files::BundleAction.list
 
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
 * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ created_at, bundle_id ]`, `[ created_at, bundle_registration_id ]`, `[ bundle_id, bundle_registration_id ]` or `[ created_at, bundle_id, bundle_registration_id ]`.
 * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
 * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.

data/docs/export.md

@@ -0,0 +1,50 @@
+# Export
+
+## Example Export Object
+
+```
+{
+  "id": 1,
+  "export_status": "example",
+  "export_type": "example",
+  "download_uri": "example"
+}
+```
+
+* `id` (int64): ID for this Export
+* `export_status` (string): Status of the Export
+* `export_type` (string): Type of data being exported
+* `download_uri` (string): Link to download Export file.
+
+
+---
+
+## List Exports
+
+```
+Files::Export.list(
+  user_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.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
+* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
+
+
+---
+
+## Show Export
+
+```
+Files::Export.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Export ID.

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

@@ -42,7 +42,7 @@ module Files
     # Parameters:
     #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ created_at, bundle_id ]`, `[ created_at, bundle_registration_id ]`, `[ bundle_id, bundle_registration_id ]` or `[ created_at, bundle_id, bundle_registration_id ]`.
     #   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
     #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Files
+  class Export
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - ID for this Export
+    def id
+      @attributes[:id]
+    end
+
+    # string - Status of the Export
+    def export_status
+      @attributes[:export_status]
+    end
+
+    # string - Type of data being exported
+    def export_type
+      @attributes[:export_type]
+    end
+
+    # string - Link to download Export file.
+    def download_uri
+      @attributes[:download_uri]
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
+    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
+    #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
+
+      List.new(Export, params) do
+        Api.send_request("/exports", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Export ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/exports/#{params[:id]}", :get, params, options)
+      Export.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+  end
+end

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.172"
+  VERSION = "1.1.173"
 end

data/lib/files.com.rb

@@ -62,6 +62,7 @@ require "files.com/models/email_incoming_message"
 require "files.com/models/email_log"
 require "files.com/models/errors"
 require "files.com/models/exavault_api_request_log"
+require "files.com/models/export"
 require "files.com/models/external_event"
 require "files.com/models/file"
 require "files.com/models/file_action"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.172
+  version: 1.1.173
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -144,6 +144,7 @@ files:
 - docs/email_log.md
 - docs/errors.md
 - docs/exavault_api_request_log.md
+- docs/export.md
 - docs/external_event.md
 - docs/file.md
 - docs/file_action.md
@@ -248,6 +249,7 @@ files:
 - lib/files.com/models/email_log.rb
 - lib/files.com/models/errors.rb
 - lib/files.com/models/exavault_api_request_log.rb
+- lib/files.com/models/export.rb
 - lib/files.com/models/external_event.rb
 - lib/files.com/models/file.rb
 - lib/files.com/models/file_action.rb