files.com 1.0.76 → 1.0.77

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e92b02ee9649f4629d85231228a8f1d6b59d81b458ee9c7503e3ed244f08f7c7
-  data.tar.gz: 1c06cb0d6e39863cbf38291043f757b30133dd27db493ff6183c61b9941bfb51
+  metadata.gz: d9a51f85cdfb6f53328a7ba37b464c4c1e92f741707e0598b4ed4b70a608b5dc
+  data.tar.gz: 5e3d7b201f518ff1f65c0ddc1943dee7f549693141935f950786b0293396c368
 SHA512:
-  metadata.gz: bb9cb7d730a80e1bb9aab05cb5927e813015b429f0d4f32724d7956fda0e78dc1ede4a5c616b6e630ff51c666e58f089a0f6edc757161e556cd8cd5f6c26e4cc
-  data.tar.gz: 2a9079000a415245a92ee1d809974a2cfe167cf46d16292c11de8ecdc5253328562f676171595a2c7e681dd7c8c5c06e193af77333a86e20471fef7d8bc63985
+  metadata.gz: 28568c4de2bcf15925978fa9c645be7c4614bd276287103226bcafb949e001de1d07946274d82239c80b87ad1153bc9d1c8c194f64d5f75b1a0635265f97bb0b
+  data.tar.gz: 0e1a26eba12d2567865ef7d0555d088dce57710064eac501db9a6a9b870dfe7749800a7c9633bb75dbb03b036c1879063e499fd0b88dd7e29e3e5b4bc95d2610

data/_VERSION

@@ -1 +1 @@
-1.0.76
+1.0.77

data/docs/bundle.md

@@ -13,10 +13,12 @@
   "id": 1,
   "created_at": "2000-01-01T01:00:00Z",
   "expires_at": "2000-01-01T01:00:00Z",
+  "max_uses": 1,
   "note": "The internal note on the bundle.",
   "user_id": 1,
   "username": "user",
   "clickwrap_id": 1,
+  "inbox_id": 1,
   "paths": [
 
   ]
@@ -32,10 +34,12 @@
 * `id` (int64): Bundle ID
 * `created_at` (date-time): Bundle created at date/time
 * `expires_at` (date-time): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
 * `note` (string): Bundle internal note
 * `user_id` (int64): Bundle creator user ID
 * `username` (string): Bundle creator username
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
 * `paths` (array): A list of paths in this bundle
 * `password` (string): Password for this bundle.
 
@@ -83,11 +87,13 @@ Files::Bundle.create(
   paths: ["file.txt"], 
   password: "Password", 
   expires_at: "2000-01-01T01:00:00Z", 
+  max_uses: 1, 
   description: "The public description of the bundle.", 
   note: "The internal note on the bundle.", 
   code: "abc123", 
   require_registration: true, 
-  clickwrap_id: 1
+  clickwrap_id: 1, 
+  inbox_id: 1
 )
 ```
 
@@ -97,11 +103,13 @@ Files::Bundle.create(
 * `paths` (array(string)): Required - A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
 * `expires_at` (string): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
 
 
 ---
@@ -130,11 +138,13 @@ Files::Bundle.share(id,
 Files::Bundle.update(id, 
   password: "Password", 
   expires_at: "2000-01-01T01:00:00Z", 
+  max_uses: 1, 
   description: "The public description of the bundle.", 
   note: "The internal note on the bundle.", 
   code: "abc123", 
   require_registration: true, 
-  clickwrap_id: 1
+  clickwrap_id: 1, 
+  inbox_id: 1
 )
 ```
 
@@ -143,11 +153,13 @@ Files::Bundle.update(id,
 * `id` (int64): Required - Bundle ID.
 * `password` (string): Password for this bundle.
 * `expires_at` (string): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
 
 
 ---
@@ -193,11 +205,13 @@ bundle = Files::Bundle.list_for(path).first
 bundle.update(
   password: "Password",
   expires_at: "2000-01-01T01:00:00Z",
+  max_uses: 1,
   description: "The public description of the bundle.",
   note: "The internal note on the bundle.",
   code: "abc123",
   require_registration: true,
-  clickwrap_id: 1
+  clickwrap_id: 1,
+  inbox_id: 1
 )
 ```
 
@@ -206,11 +220,13 @@ bundle.update(
 * `id` (int64): Required - Bundle ID.
 * `password` (string): Password for this bundle.
 * `expires_at` (string): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
 
 
 ---

data/docs/bundle_download.md

@@ -0,0 +1,35 @@
+# BundleDownload
+
+## Example BundleDownload Object
+
+```
+{
+  "download_method": "file",
+  "path": "a/b/test.txt",
+  "created_at": "2020-01-01 00:00:00"
+}
+```
+
+* `download_method` (string): Download method (file or full_zip)
+* `path` (string): Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `created_at` (date-time): Download date/time
+
+
+---
+
+## List Bundle Downloads
+
+```
+Files::BundleDownload.list(
+  page: 1, 
+  per_page: 1, 
+  bundle_registration_id: 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.
+* `bundle_registration_id` (int64): Required - BundleRegistration ID

data/lib/files.com.rb

@@ -34,6 +34,7 @@ require "files.com/models/auto"
 require "files.com/models/automation"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
+require "files.com/models/bundle_download"
 require "files.com/models/clickwrap"
 require "files.com/models/dns_record"
 require "files.com/models/errors"

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

@@ -86,6 +86,15 @@ module Files
       @attributes[:expires_at] = value
     end
 
+    # int64 - Maximum number of times bundle can be accessed
+    def max_uses
+      @attributes[:max_uses]
+    end
+
+    def max_uses=(value)
+      @attributes[:max_uses] = value
+    end
+
     # string - Bundle internal note
     def note
       @attributes[:note]
@@ -122,6 +131,15 @@ module Files
       @attributes[:clickwrap_id] = value
     end
 
+    # int64 - ID of the associated inbox, if available.
+    def inbox_id
+      @attributes[:inbox_id]
+    end
+
+    def inbox_id=(value)
+      @attributes[:inbox_id] = value
+    end
+
     # array - A list of paths in this bundle
     def paths
       @attributes[:paths]
@@ -161,11 +179,13 @@ module Files
     # Parameters:
     #   password - string - Password for this bundle.
     #   expires_at - string - Bundle expiration date/time
+    #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   description - string - Public description
     #   note - string - Bundle internal note
     #   code - string - Bundle code.  This code forms the end part of the Public URL.
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
+    #   inbox_id - int64 - ID of the associated inbox, if available.
     def update(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -173,10 +193,12 @@ module Files
       raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       Api.send_request("/bundles/#{@attributes[:id]}", :patch, params, @options)
@@ -247,20 +269,24 @@ module Files
     #   paths (required) - array(string) - A list of paths to include in this bundle.
     #   password - string - Password for this bundle.
     #   expires_at - string - Bundle expiration date/time
+    #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   description - string - Public description
     #   note - string - Bundle internal note
     #   code - string - Bundle code.  This code forms the end part of the Public URL.
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
+    #   inbox_id - int64 - ID of the associated inbox, if available.
     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: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
       raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: paths") unless params.dig(:paths)
 
       response, options = Api.send_request("/bundles", :post, params, options)
@@ -288,21 +314,25 @@ module Files
     # Parameters:
     #   password - string - Password for this bundle.
     #   expires_at - string - Bundle expiration date/time
+    #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   description - string - Public description
     #   note - string - Bundle internal note
     #   code - string - Bundle code.  This code forms the end part of the Public URL.
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
+    #   inbox_id - int64 - ID of the associated inbox, if available.
     def self.update(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 InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       response, options = Api.send_request("/bundles/#{params[:id]}", :patch, params, options)

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Files
+  class BundleDownload
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Download method (file or full_zip)
+    def download_method
+      @attributes[:download_method]
+    end
+
+    # string - Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    def path
+      @attributes[:path]
+    end
+
+    # date-time - Download date/time
+    def created_at
+      @attributes[:created_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.
+    #   bundle_registration_id (required) - int64 - BundleRegistration ID
+    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: bundle_registration_id must be an Integer") if params.dig(:bundle_registration_id) and !params.dig(:bundle_registration_id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: bundle_registration_id") unless params.dig(:bundle_registration_id)
+
+      response, options = Api.send_request("/bundle_downloads", :get, params, options)
+      response.data.map do |entity_data|
+        BundleDownload.new(entity_data, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.76
+  version: 1.0.77
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -92,6 +92,7 @@ files:
 - docs/automation.md
 - docs/behavior.md
 - docs/bundle.md
+- docs/bundle_download.md
 - docs/clickwrap.md
 - docs/dns_record.md
 - docs/errors.md
@@ -147,6 +148,7 @@ files:
 - lib/files.com/models/automation.rb
 - lib/files.com/models/behavior.rb
 - lib/files.com/models/bundle.rb
+- lib/files.com/models/bundle_download.rb
 - lib/files.com/models/clickwrap.rb
 - lib/files.com/models/dir.rb
 - lib/files.com/models/dns_record.rb