files.com 1.0.218 → 1.0.222

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dc12025aafa302829b6a20732239036c7592f735ccc2ee7eab06c806d60a6c7
-  data.tar.gz: c333474a157e59d1fbefa02bec5deaccbb5330a706ad5e233202402c6c932487
+  metadata.gz: a4740d16a35756c850793e85565092bc484aa782b57f1327f2b49879bb9c51e9
+  data.tar.gz: 4356ee405876e0efe117bd4f51cf9929691f03a4124b5c710cd54e033e4980e8
 SHA512:
-  metadata.gz: 9527d182e3fab45a495d4c0594e5ea05426c3ad2b12ef1a224020c048b05ea9f7665805f1cb0aab13d8e8a77bfdbd151941ce98dc9b70eef93d99d89f2523691
-  data.tar.gz: 711764af7326a13e21d50ed05af0e10d9e3b7700e72f61b3788657a0f52634b536d07247709d0155c6c3a989f6f7d6f58bd38f6b9e5e33bcb009277b0392a7df
+  metadata.gz: d3148181f696f031dde933cc4ee7d485ada9859fb2e16e1c881ebfe1f5ff1facda6bb6f84dc6feee7924cbb3eee3ff6f2e6475efd6c8d43c1bcada374f299659
+  data.tar.gz: 4490d4d8fd11640db9836b23b06a68e7207868dc5ff4279dc67a78f7a035d1ca28369aa169679190a062b6690136268111c195d76446436c5c0daab85a666360

data/_VERSION

@@ -1 +1 @@
-1.0.218
+1.0.222

data/docs/automation_run.md

@@ -4,13 +4,19 @@
 
 ```
 {
+  "id": 1,
   "automation_id": 1,
+  "completed_at": "2000-01-01T01:00:00Z",
+  "created_at": "2000-01-01T01:00:00Z",
   "status": "success",
   "status_messages_url": "https://www.example.com/log_file.txt"
 }
 ```
 
+* `id` (int64): ID.
 * `automation_id` (int64): ID of the associated Automation.
+* `completed_at` (date-time): Automation run completion/failure date/time.
+* `created_at` (date-time): Automation run start date/time.
 * `status` (string): The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
 * `status_messages_url` (string): Link to status messages log file.
 
@@ -40,3 +46,16 @@ Files::AutomationRun.list(
 * `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `status`.
 * `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `status`.
 * `automation_id` (int64): Required - ID of the associated Automation.
+
+
+---
+
+## Show Automation Run
+
+```
+Files::AutomationRun.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Automation Run ID.

data/docs/bundle_registration.md

@@ -13,6 +13,7 @@
   "clickwrap_body": "",
   "form_field_set_id": 1,
   "form_field_data": "",
+  "bundle_code": "",
   "bundle_id": 1,
   "bundle_recipient_id": 1
 }
@@ -27,6 +28,7 @@
 * `clickwrap_body` (string): Clickwrap text that was shown to the registrant
 * `form_field_set_id` (int64): Id of associated form field set
 * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
+* `bundle_code` (string): Bundle URL code
 * `bundle_id` (int64): Id of associated bundle
 * `bundle_recipient_id` (int64): Id of associated bundle recipient
 

data/docs/file.md

@@ -27,7 +27,8 @@ may places where a Ruby File object can be used.
     "status": "complete",
     "download_uri": "https://mysite.files.com/...",
     "type": "complete",
-    "size": 1024
+    "size": 1024,
+    "status_message": ""
   }
 }
 ```
@@ -212,6 +213,7 @@ Files::File.begin_upload(path,
   parts: 1, 
   ref: "upload-1", 
   restart: 1, 
+  size: 1, 
   with_rename: true
 )
 ```
@@ -224,6 +226,7 @@ Files::File.begin_upload(path,
 * `parts` (int64): How many parts to fetch?
 * `ref` (string): 
 * `restart` (int64): File byte offset to restart from.
+* `size` (int64): Total bytes of file being uploaded (include bytes being retained if appending/restarting).
 * `with_rename` (boolean): Allow file rename instead of overwrite?
 
 
@@ -338,6 +341,7 @@ file.begin_upload(
   parts: 1,
   ref: "upload-1",
   restart: 1,
+  size: 1,
   with_rename: true
 )
 ```
@@ -350,4 +354,5 @@ file.begin_upload(
 * `parts` (int64): How many parts to fetch?
 * `ref` (string): 
 * `restart` (int64): File byte offset to restart from.
+* `size` (int64): Total bytes of file being uploaded (include bytes being retained if appending/restarting).
 * `with_rename` (boolean): Allow file rename instead of overwrite?

data/docs/folder.md

@@ -29,7 +29,8 @@ Files::Dir is an alias of Files::Folder
     "status": "complete",
     "download_uri": "https://mysite.files.com/...",
     "type": "complete",
-    "size": 1024
+    "size": 1024,
+    "status_message": ""
   }
 }
 ```

data/docs/inbox_registration.md

@@ -12,7 +12,8 @@
   "form_field_set_id": 1,
   "form_field_data": "",
   "inbox_id": 1,
-  "inbox_recipient_id": 1
+  "inbox_recipient_id": 1,
+  "inbox_title": ""
 }
 ```
 
@@ -25,6 +26,7 @@
 * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
 * `inbox_id` (int64): Id of associated inbox
 * `inbox_recipient_id` (int64): Id of associated inbox recipient
+* `inbox_title` (string): Title of associated inbox
 
 
 ---

data/docs/preview.md

@@ -8,7 +8,8 @@
   "status": "complete",
   "download_uri": "https://mysite.files.com/...",
   "type": "complete",
-  "size": 1024
+  "size": 1024,
+  "status_message": ""
 }
 ```
 
@@ -17,3 +18,4 @@
 * `download_uri` (string): Link to download preview
 * `type` (string): Preview status.  Can be invalid, not_generated, generating, complete, or file_too_large
 * `size` (int64): Preview size
+* `status_message` (string): Preview status message. Addtional context from the preview generation process about the status

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

@@ -9,11 +9,26 @@ module Files
       @options = options || {}
     end
 
+    # int64 - ID.
+    def id
+      @attributes[:id]
+    end
+
     # int64 - ID of the associated Automation.
     def automation_id
       @attributes[:automation_id]
     end
 
+    # date-time - Automation run completion/failure date/time.
+    def completed_at
+      @attributes[:completed_at]
+    end
+
+    # date-time - Automation run start date/time.
+    def created_at
+      @attributes[:created_at]
+    end
+
     # string - The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
     def status
       @attributes[:status]
@@ -58,5 +73,21 @@ module Files
     def self.all(params = {}, options = {})
       list(params, options)
     end
+
+    # Parameters:
+    #   id (required) - int64 - Automation Run 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("/automation_runs/#{params[:id]}", :get, params, options)
+      AutomationRun.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
   end
 end

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

@@ -54,6 +54,11 @@ module Files
       @attributes[:form_field_data]
     end
 
+    # string - Bundle URL code
+    def bundle_code
+      @attributes[:bundle_code]
+    end
+
     # int64 - Id of associated bundle
     def bundle_id
       @attributes[:bundle_id]

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

@@ -155,7 +155,7 @@ module Files
       etags ||= []
       bytes_written = 0
       loop do
-        begin_upload = FileAction.begin_upload(path, { ref: upload&.ref, part: (upload&.part_number || 0) + 1 }, options)
+        begin_upload = File.begin_upload(path, { ref: upload&.ref, part: (upload&.part_number || 0) + 1 }, options)
         upload = begin_upload.is_a?(Enumerable) ? begin_upload.first : begin_upload
         buf = io.read(upload.partsize) || ""
         bytes_written += buf.length
@@ -908,6 +908,7 @@ module Files
     #   parts - int64 - How many parts to fetch?
     #   ref - string -
     #   restart - int64 - File byte offset to restart from.
+    #   size - int64 - Total bytes of file being uploaded (include bytes being retained if appending/restarting).
     #   with_rename - boolean - Allow file rename instead of overwrite?
     def begin_upload(params = {})
       params ||= {}
@@ -918,6 +919,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: parts must be an Integer") if params.dig(:parts) and !params.dig(:parts).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: ref must be an String") if params.dig(:ref) and !params.dig(:ref).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: restart must be an Integer") if params.dig(:restart) and !params.dig(:restart).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: size must be an Integer") if params.dig(:size) and !params.dig(:size).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
       Api.send_request("/file_actions/begin_upload/#{@attributes[:path]}", :post, params, @options)
@@ -1073,6 +1075,7 @@ module Files
     #   parts - int64 - How many parts to fetch?
     #   ref - string -
     #   restart - int64 - File byte offset to restart from.
+    #   size - int64 - Total bytes of file being uploaded (include bytes being retained if appending/restarting).
     #   with_rename - boolean - Allow file rename instead of overwrite?
     def self.begin_upload(path, params = {}, options = {})
       params ||= {}
@@ -1082,6 +1085,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: parts must be an Integer") if params.dig(:parts) and !params.dig(:parts).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: ref must be an String") if params.dig(:ref) and !params.dig(:ref).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: restart must be an Integer") if params.dig(:restart) and !params.dig(:restart).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: size must be an Integer") if params.dig(:size) and !params.dig(:size).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
       response, options = Api.send_request("/file_actions/begin_upload/#{params[:path]}", :post, params, options)

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

@@ -54,6 +54,11 @@ module Files
       @attributes[:inbox_recipient_id]
     end
 
+    # string - Title of associated inbox
+    def inbox_title
+      @attributes[:inbox_title]
+    end
+
     # Parameters:
     #   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).

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

@@ -33,5 +33,10 @@ module Files
     def size
       @attributes[:size]
     end
+
+    # string - Preview status message. Addtional context from the preview generation process about the status
+    def status_message
+      @attributes[:status_message]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.218
+  version: 1.0.222
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable