Class: Files::Style

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Style.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



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

def options
  @options
end

Class Method Details

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



100
101
102
 
# File 'lib/files.com/models/style.rb', line 100

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

.delete(path, params = {}, options = {}) ⇒ Object

Raises:



117
118
119
120
121
122
123
124
125
 
# File 'lib/files.com/models/style.rb', line 117

def self.delete(path, params = {}, options = {})
  params ||= {}
  params[:path] = path
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
  raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)

  response, _options = Api.send_request("/styles/#{URI.encode_www_form_component(params[:path])}", :delete, params, options)
  response.data
end

.destroy(path, params = {}, options = {}) ⇒ Object 



127
128
129
 
# File 'lib/files.com/models/style.rb', line 127

def self.destroy(path, params = {}, options = {})
  delete(path, params, options)
end

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

Parameters:

path (required) - string - Style path.

Raises:



90
91
92
93
94
95
96
97
98
 
# File 'lib/files.com/models/style.rb', line 90

def self.list(path, params = {}, options = {})
  params ||= {}
  params[:path] = path
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
  raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)

  response, options = Api.send_request("/styles/#{URI.encode_www_form_component(params[:path])}", :get, params, options)
  Style.new(response.data, options)
end

.update(path, params = {}, options = {}) ⇒ Object

Parameters:

file (required) - file - Logo for custom branding.

Raises:



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/files.com/models/style.rb', line 106

def self.update(path, params = {}, options = {})
  params ||= {}
  params[:path] = path
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
  raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
  raise MissingParameterError.new("Parameter missing: file") unless params.dig(:file)

  response, options = Api.send_request("/styles/#{URI.encode_www_form_component(params[:path])}", :patch, params, options)
  Style.new(response.data, options)
end

Instance Method Details

#delete(params = {}) ⇒ Object

Raises:



70
71
72
73
74
75
76
77
78
 
# File 'lib/files.com/models/style.rb', line 70

def delete(params = {})
  params ||= {}
  params[:path] = @attributes[:path]
  raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
  raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)

  Api.send_request("/styles/#{Addressable::URI.encode_component(params[:path])}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



80
81
82
 
# File 'lib/files.com/models/style.rb', line 80

def destroy(params = {})
  delete(params)
end

#file ⇒ Object

file - Logo for custom branding.



49
50
51
 
# File 'lib/files.com/models/style.rb', line 49

def file
  @attributes[:file]
end

#file=(value) ⇒ Object 



53
54
55
 
# File 'lib/files.com/models/style.rb', line 53

def file=(value)
  @attributes[:file] = value
end

#id ⇒ Object

int64 - Style ID



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



17
18
19
 
# File 'lib/files.com/models/style.rb', line 17

def id=(value)
  @attributes[:id] = value
end

#logo ⇒ Object

Logo



31
32
33
 
# File 'lib/files.com/models/style.rb', line 31

def 
  @attributes[:logo]
end

#logo=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/style.rb', line 35

def logo=(value)
  @attributes[:logo] = value
end

#path ⇒ Object

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



22
23
24
 
# File 'lib/files.com/models/style.rb', line 22

def path
  @attributes[:path]
end

#path=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/style.rb', line 26

def path=(value)
  @attributes[:path] = value
end

#save ⇒ Object 



84
85
86
 
# File 'lib/files.com/models/style.rb', line 84

def save
  update(@attributes)
end

#thumbnail ⇒ Object

Logo thumbnail



40
41
42
 
# File 'lib/files.com/models/style.rb', line 40

def thumbnail
  @attributes[:thumbnail]
end

#thumbnail=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/style.rb', line 44

def thumbnail=(value)
  @attributes[:thumbnail] = value
end

#update(params = {}) ⇒ Object

Parameters:

file (required) - file - Logo for custom branding.

Raises:



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/files.com/models/style.rb', line 59

def update(params = {})
  params ||= {}
  params[:path] = @attributes[:path]
  raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
  raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
  raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
  raise MissingParameterError.new("Parameter missing: file") unless params.dig(:file)

  Api.send_request("/styles/#{Addressable::URI.encode_component(params[:path])}", :patch, params, @options)
end