Class: Files::BundleDownload

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/bundle_download.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ BundleDownload

Returns a new instance of BundleDownload.



7
8
9
10
 
# File 'lib/files.com/models/bundle_download.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/bundle_download.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/bundle_download.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



42
43
44
 
# File 'lib/files.com/models/bundle_download.rb', line 42

def self.all(params = {}, options = {})
  list(params, options)
end

.list(params = {}, options = {}) ⇒ Object

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).
bundle_registration_id (required) - int64 - BundleRegistration ID

Raises:



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/files.com/models/bundle_download.rb', line 31

def self.list(params = {}, options = {})
  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: 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)

  List.new(BundleDownload, params) do
    Api.send_request("/bundle_downloads", :get, params, options)
  end
end

Instance Method Details

#created_at ⇒ Object

date-time - Download date/time



23
24
25
 
# File 'lib/files.com/models/bundle_download.rb', line 23

def created_at
  @attributes[:created_at]
end

#download_method ⇒ Object

string - Download method (file or full_zip)



13
14
15
 
# File 'lib/files.com/models/bundle_download.rb', line 13

def download_method
  @attributes[:download_method]
end

#path ⇒ Object

string - Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.



18
19
20
 
# File 'lib/files.com/models/bundle_download.rb', line 18

def path
  @attributes[:path]
end