Class: Files::UsageDailySnapshot

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of UsageDailySnapshot.



7
8
9
10
 
# File 'lib/files.com/models/usage_daily_snapshot.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/usage_daily_snapshot.rb', line 5

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



47
48
49
 
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 47

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

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

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.

Raises:



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 36

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)

  response, options = Api.send_request("/usage_daily_snapshots", :get, params, options)
  response.data.map do |entity_data|
    UsageDailySnapshot.new(entity_data, options)
  end
end

Instance Method Details

#current_storage ⇒ Object

int64 - The quantity of storage held for this site



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

def current_storage
  @attributes[:current_storage]
end

#date ⇒ Object

date - The date of this usage record



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

def date
  @attributes[:date]
end

#id ⇒ Object

int64 - ID of the usage record



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

def id
  @attributes[:id]
end

#usage_by_top_level_dir ⇒ Object

array - Usage broken down by each top-level folder



28
29
30
 
# File 'lib/files.com/models/usage_daily_snapshot.rb', line 28

def usage_by_top_level_dir
  @attributes[:usage_by_top_level_dir]
end