Class: Files::Project
- Inherits:
-
Object
- Object
- Files::Project
- Defined in:
- lib/files.com/models/project.rb
Instance Attribute Summary collapse
-
#attributes ⇒ Object
readonly
Returns the value of attribute attributes.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Class Method Summary collapse
- .all(params = {}, options = {}) ⇒ Object
-
.create(params = {}, options = {}) ⇒ Object
Parameters: global_access (required) - string - Global permissions.
- .delete(id, params = {}, options = {}) ⇒ Object
- .destroy(id, params = {}, options = {}) ⇒ Object
-
.find(id, params = {}, options = {}) ⇒ Object
Parameters: id (required) - int64 - Project ID.
- .get(id, params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
-
.update(id, params = {}, options = {}) ⇒ Object
Parameters: global_access (required) - string - Global permissions.
Instance Method Summary collapse
- #delete(params = {}) ⇒ Object
- #destroy(params = {}) ⇒ Object
-
#global_access ⇒ Object
string - Global access settings.
- #global_access=(value) ⇒ Object
-
#id ⇒ Object
int64 - Project ID.
- #id=(value) ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ Project
constructor
A new instance of Project.
- #save ⇒ Object
-
#update(params = {}) ⇒ Object
Parameters: global_access (required) - string - Global permissions.
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ Project
Returns a new instance of Project.
7 8 9 10 |
# File 'lib/files.com/models/project.rb', line 7 def initialize(attributes = {}, = {}) @attributes = attributes || {} @options = || {} end |
Instance Attribute Details
#attributes ⇒ Object (readonly)
Returns the value of attribute attributes.
5 6 7 |
# File 'lib/files.com/models/project.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/project.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
86 87 88 |
# File 'lib/files.com/models/project.rb', line 86 def self.all(params = {}, = {}) list(params, ) end |
.create(params = {}, options = {}) ⇒ Object
Parameters:
global_access (required) - string - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
108 109 110 111 112 113 114 |
# File 'lib/files.com/models/project.rb', line 108 def self.create(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: global_access must be an String") if params[:global_access] and !params[:global_access].is_a?(String) raise MissingParameterError.new("Parameter missing: global_access") unless params[:global_access] response, = Api.send_request("/projects", :post, params, ) Project.new(response.data, ) end |
.delete(id, params = {}, options = {}) ⇒ Object
130 131 132 133 134 135 136 137 138 |
# File 'lib/files.com/models/project.rb', line 130 def self.delete(id, params = {}, = {}) params ||= {} params[:id] = id raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer) raise MissingParameterError.new("Parameter missing: id") unless params[:id] Api.send_request("/projects/#{params[:id]}", :delete, params, ) nil end |
.destroy(id, params = {}, options = {}) ⇒ Object
140 141 142 143 |
# File 'lib/files.com/models/project.rb', line 140 def self.destroy(id, params = {}, = {}) delete(id, params, ) nil end |
.find(id, params = {}, options = {}) ⇒ Object
Parameters:
id (required) - int64 - Project ID.
92 93 94 95 96 97 98 99 100 |
# File 'lib/files.com/models/project.rb', line 92 def self.find(id, params = {}, = {}) params ||= {} params[:id] = id raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer) raise MissingParameterError.new("Parameter missing: id") unless params[:id] response, = Api.send_request("/projects/#{params[:id]}", :get, params, ) Project.new(response.data, ) end |
.get(id, params = {}, options = {}) ⇒ Object
102 103 104 |
# File 'lib/files.com/models/project.rb', line 102 def self.get(id, params = {}, = {}) find(id, params, ) end |
.list(params = {}, options = {}) ⇒ Object
Parameters:
cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
action - string
page - int64
75 76 77 78 79 80 81 82 83 84 |
# File 'lib/files.com/models/project.rb', line 75 def self.list(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String) raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer) raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String) raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer) List.new(Project, params) do Api.send_request("/projects", :get, params, ) end end |
.update(id, params = {}, options = {}) ⇒ Object
Parameters:
global_access (required) - string - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/files.com/models/project.rb', line 118 def self.update(id, params = {}, = {}) params ||= {} params[:id] = id raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer) raise InvalidParameterError.new("Bad parameter: global_access must be an String") if params[:global_access] and !params[:global_access].is_a?(String) raise MissingParameterError.new("Parameter missing: id") unless params[:id] raise MissingParameterError.new("Parameter missing: global_access") unless params[:global_access] response, = Api.send_request("/projects/#{params[:id]}", :patch, params, ) Project.new(response.data, ) end |
Instance Method Details
#delete(params = {}) ⇒ Object
44 45 46 47 48 49 50 51 52 |
# File 'lib/files.com/models/project.rb', line 44 def delete(params = {}) params ||= {} params[:id] = @attributes[:id] raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id] raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer) raise MissingParameterError.new("Parameter missing: id") unless params[:id] Api.send_request("/projects/#{@attributes[:id]}", :delete, params, @options) end |
#destroy(params = {}) ⇒ Object
54 55 56 57 |
# File 'lib/files.com/models/project.rb', line 54 def destroy(params = {}) delete(params) nil end |
#global_access ⇒ Object
string - Global access settings
22 23 24 |
# File 'lib/files.com/models/project.rb', line 22 def global_access @attributes[:global_access] end |
#global_access=(value) ⇒ Object
26 27 28 |
# File 'lib/files.com/models/project.rb', line 26 def global_access=(value) @attributes[:global_access] = value end |
#id ⇒ Object
int64 - Project ID
13 14 15 |
# File 'lib/files.com/models/project.rb', line 13 def id @attributes[:id] end |
#id=(value) ⇒ Object
17 18 19 |
# File 'lib/files.com/models/project.rb', line 17 def id=(value) @attributes[:id] = value end |
#save ⇒ Object
59 60 61 62 63 64 65 66 67 68 |
# File 'lib/files.com/models/project.rb', line 59 def save if @attributes[:id] new_obj = update(@attributes) else new_obj = Project.create(@attributes, @options) end @attributes = new_obj.attributes true end |
#update(params = {}) ⇒ Object
Parameters:
global_access (required) - string - Global permissions. Can be: `none`, `anyone_with_read`, `anyone_with_full`.
32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/files.com/models/project.rb', line 32 def update(params = {}) params ||= {} params[:id] = @attributes[:id] raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id] raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer) raise InvalidParameterError.new("Bad parameter: global_access must be an String") if params[:global_access] and !params[:global_access].is_a?(String) raise MissingParameterError.new("Parameter missing: id") unless params[:id] raise MissingParameterError.new("Parameter missing: global_access") unless params[:global_access] Api.send_request("/projects/#{@attributes[:id]}", :patch, params, @options) end |