Class: Files::UserRequest
- Inherits:
-
Object
- Object
- Files::UserRequest
- Defined in:
- lib/files.com/models/user_request.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: name (required) - string - Name of user requested email (required) - string - Email of user requested details (required) - string - Details of the user request.
- .delete(id, params = {}, options = {}) ⇒ Object
- .destroy(id, params = {}, options = {}) ⇒ Object
-
.find(id, params = {}, options = {}) ⇒ Object
Parameters: id (required) - int64 - User Request ID.
- .get(id, params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: page - int64 - Current page number.
Instance Method Summary collapse
- #delete(params = {}) ⇒ Object
- #destroy(params = {}) ⇒ Object
-
#details ⇒ Object
string - Details of the user’s request.
- #details=(value) ⇒ Object
-
#email ⇒ Object
email - User email address.
- #email=(value) ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ UserRequest
constructor
A new instance of UserRequest.
-
#name ⇒ Object
string - User’s full name.
- #name=(value) ⇒ Object
- #save ⇒ Object
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ UserRequest
Returns a new instance of UserRequest.
7 8 9 10 |
# File 'lib/files.com/models/user_request.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/user_request.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/user_request.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
77 78 79 |
# File 'lib/files.com/models/user_request.rb', line 77 def self.all(params = {}, = {}) list(params, ) end |
.create(params = {}, options = {}) ⇒ Object
Parameters:
name (required) - string - Name of user requested
email (required) - string - Email of user requested
details (required) - string - Details of the user request
101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/files.com/models/user_request.rb', line 101 def self.create(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String) raise InvalidParameterError.new("Bad parameter: email must be an String") if params.dig(:email) and !params.dig(:email).is_a?(String) raise InvalidParameterError.new("Bad parameter: details must be an String") if params.dig(:details) and !params.dig(:details).is_a?(String) raise MissingParameterError.new("Parameter missing: name") unless params.dig(:name) raise MissingParameterError.new("Parameter missing: email") unless params.dig(:email) raise MissingParameterError.new("Parameter missing: details") unless params.dig(:details) response, = Api.send_request("/user_requests", :post, params, ) UserRequest.new(response.data, ) end |
.delete(id, params = {}, options = {}) ⇒ Object
113 114 115 116 117 118 119 120 121 |
# File 'lib/files.com/models/user_request.rb', line 113 def self.delete(id, params = {}, = {}) 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 MissingParameterError.new("Parameter missing: id") unless params.dig(:id) response, = Api.send_request("/user_requests/#{params[:id]}", :delete, params, ) response.data end |
.destroy(id, params = {}, options = {}) ⇒ Object
123 124 125 |
# File 'lib/files.com/models/user_request.rb', line 123 def self.destroy(id, params = {}, = {}) delete(id, params, ) end |
.find(id, params = {}, options = {}) ⇒ Object
Parameters:
id (required) - int64 - User Request ID.
83 84 85 86 87 88 89 90 91 |
# File 'lib/files.com/models/user_request.rb', line 83 def self.find(id, params = {}, = {}) 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 MissingParameterError.new("Parameter missing: id") unless params.dig(:id) response, = Api.send_request("/user_requests/#{params[:id]}", :get, params, ) UserRequest.new(response.data, ) end |
.get(id, params = {}, options = {}) ⇒ Object
93 94 95 |
# File 'lib/files.com/models/user_request.rb', line 93 def self.get(id, params = {}, = {}) find(id, params, ) 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.
66 67 68 69 70 71 72 73 74 75 |
# File 'lib/files.com/models/user_request.rb', line 66 def self.list(params = {}, = {}) 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, = Api.send_request("/user_requests", :get, params, ) response.data.map do |entity_data| UserRequest.new(entity_data, ) end end |
Instance Method Details
#delete(params = {}) ⇒ Object
39 40 41 42 43 44 45 46 47 |
# File 'lib/files.com/models/user_request.rb', line 39 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.dig(:id) and !params.dig(:id).is_a?(Integer) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) Api.send_request("/user_requests/#{@attributes[:id]}", :delete, params, @options) end |
#destroy(params = {}) ⇒ Object
49 50 51 |
# File 'lib/files.com/models/user_request.rb', line 49 def destroy(params = {}) delete(params) end |
#details ⇒ Object
string - Details of the user’s request
31 32 33 |
# File 'lib/files.com/models/user_request.rb', line 31 def details @attributes[:details] end |
#details=(value) ⇒ Object
35 36 37 |
# File 'lib/files.com/models/user_request.rb', line 35 def details=(value) @attributes[:details] = value end |
#email ⇒ Object
email - User email address
22 23 24 |
# File 'lib/files.com/models/user_request.rb', line 22 def email @attributes[:email] end |
#email=(value) ⇒ Object
26 27 28 |
# File 'lib/files.com/models/user_request.rb', line 26 def email=(value) @attributes[:email] = value end |
#name ⇒ Object
string - User’s full name
13 14 15 |
# File 'lib/files.com/models/user_request.rb', line 13 def name @attributes[:name] end |
#name=(value) ⇒ Object
17 18 19 |
# File 'lib/files.com/models/user_request.rb', line 17 def name=(value) @attributes[:name] = value end |
#save ⇒ Object
53 54 55 56 57 58 59 60 |
# File 'lib/files.com/models/user_request.rb', line 53 def save if @attributes[:id] raise NotImplementedError.new("The UserRequest object doesn't support updates.") else new_obj = UserRequest.create(@attributes, @options) @attributes = new_obj.attributes end end |