Class: Files::Notification
- Inherits:
-
Object
- Object
- Files::Notification
- Defined in:
- lib/files.com/models/notification.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: user_id - int64 - The id of the user to notify.
- .delete(id, params = {}, options = {}) ⇒ Object
- .destroy(id, params = {}, options = {}) ⇒ Object
-
.find(id, params = {}, options = {}) ⇒ Object
Parameters: id (required) - int64 - Notification ID.
- .get(id, params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: user_id - int64 - Show notifications for this User ID.
-
.update(id, params = {}, options = {}) ⇒ Object
Parameters: notify_on_copy - boolean - If ‘true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
Instance Method Summary collapse
- #delete(params = {}) ⇒ Object
- #destroy(params = {}) ⇒ Object
-
#group_id ⇒ Object
int64 - Notification group id.
- #group_id=(value) ⇒ Object
-
#group_name ⇒ Object
string - Group name if applicable.
- #group_name=(value) ⇒ Object
-
#id ⇒ Object
int64 - Notification ID.
- #id=(value) ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ Notification
constructor
A new instance of Notification.
-
#notify_on_copy ⇒ Object
boolean - Triggers notification when moving or copying files to this path.
- #notify_on_copy=(value) ⇒ Object
-
#notify_user_actions ⇒ Object
boolean - Trigger notification on notification user actions?.
- #notify_user_actions=(value) ⇒ Object
-
#path ⇒ Object
string - Folder path to notify on This must be slash-delimited, but it must neither start nor end with a slash.
- #path=(value) ⇒ Object
- #save ⇒ Object
-
#send_interval ⇒ Object
string - The time interval that notifications are aggregated to.
- #send_interval=(value) ⇒ Object
-
#suppressed_email ⇒ Object
boolean - If true, it means that the recipient at this user’s email address has manually unsubscribed from all emails, or had their email “hard bounce”, which means that we are unable to send mail to this user’s current email address.
- #suppressed_email=(value) ⇒ Object
-
#unsubscribed ⇒ Object
boolean - Is the user unsubscribed from this notification?.
- #unsubscribed=(value) ⇒ Object
-
#unsubscribed_reason ⇒ Object
string - The reason that the user unsubscribed.
- #unsubscribed_reason=(value) ⇒ Object
-
#update(params = {}) ⇒ Object
Parameters: notify_on_copy - boolean - If ‘true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
-
#user_id ⇒ Object
int64 - Notification user ID.
- #user_id=(value) ⇒ Object
-
#username ⇒ Object
string - Notification username.
- #username=(value) ⇒ Object
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ Notification
Returns a new instance of Notification.
7 8 9 10 |
# File 'lib/files.com/models/notification.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/notification.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/notification.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
174 175 176 |
# File 'lib/files.com/models/notification.rb', line 174 def self.all(params = {}, = {}) list(params, ) end |
.create(params = {}, options = {}) ⇒ Object
Parameters:
user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`.
notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
path - string - Path
username - string - The username of the user to notify. Provide `user_id`, `username` or `group_id`.
202 203 204 205 206 207 208 209 210 211 |
# File 'lib/files.com/models/notification.rb', line 202 def self.create(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: send_interval must be an String") if params.dig(:send_interval) and !params.dig(:send_interval).is_a?(String) raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String) raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String) response, = Api.send_request("/notifications", :post, params, ) Notification.new(response.data, ) end |
.delete(id, params = {}, options = {}) ⇒ Object
228 229 230 231 232 233 234 235 236 |
# File 'lib/files.com/models/notification.rb', line 228 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("/notifications/#{params[:id]}", :delete, params, ) response.data end |
.destroy(id, params = {}, options = {}) ⇒ Object
238 239 240 |
# File 'lib/files.com/models/notification.rb', line 238 def self.destroy(id, params = {}, = {}) delete(id, params, ) end |
.find(id, params = {}, options = {}) ⇒ Object
Parameters:
id (required) - int64 - Notification ID.
180 181 182 183 184 185 186 187 188 |
# File 'lib/files.com/models/notification.rb', line 180 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("/notifications/#{params[:id]}", :get, params, ) Notification.new(response.data, ) end |
.get(id, params = {}, options = {}) ⇒ Object
190 191 192 |
# File 'lib/files.com/models/notification.rb', line 190 def self.get(id, params = {}, = {}) find(id, params, ) end |
.list(params = {}, options = {}) ⇒ Object
Parameters:
user_id - int64 - Show notifications for this User ID.
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.
group_id - int64 - Show notifications for this Group ID.
164 165 166 167 168 169 170 171 172 |
# File 'lib/files.com/models/notification.rb', line 164 def self.list(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer) 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) raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer) response, = Api.send_request("/notifications", :get, params, ) end |
.update(id, params = {}, options = {}) ⇒ Object
Parameters:
notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
217 218 219 220 221 222 223 224 225 226 |
# File 'lib/files.com/models/notification.rb', line 217 def self.update(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 InvalidParameterError.new("Bad parameter: send_interval must be an String") if params.dig(:send_interval) and !params.dig(:send_interval).is_a?(String) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) response, = Api.send_request("/notifications/#{params[:id]}", :patch, params, ) Notification.new(response.data, ) end |
Instance Method Details
#delete(params = {}) ⇒ Object
135 136 137 138 139 140 141 142 143 |
# File 'lib/files.com/models/notification.rb', line 135 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("/notifications/#{@attributes[:id]}", :delete, params, @options) end |
#destroy(params = {}) ⇒ Object
145 146 147 |
# File 'lib/files.com/models/notification.rb', line 145 def destroy(params = {}) delete(params) end |
#group_id ⇒ Object
int64 - Notification group id
31 32 33 |
# File 'lib/files.com/models/notification.rb', line 31 def group_id @attributes[:group_id] end |
#group_id=(value) ⇒ Object
35 36 37 |
# File 'lib/files.com/models/notification.rb', line 35 def group_id=(value) @attributes[:group_id] = value end |
#group_name ⇒ Object
string - Group name if applicable
40 41 42 |
# File 'lib/files.com/models/notification.rb', line 40 def group_name @attributes[:group_name] end |
#group_name=(value) ⇒ Object
44 45 46 |
# File 'lib/files.com/models/notification.rb', line 44 def group_name=(value) @attributes[:group_name] = value end |
#id ⇒ Object
int64 - Notification ID
13 14 15 |
# File 'lib/files.com/models/notification.rb', line 13 def id @attributes[:id] end |
#id=(value) ⇒ Object
17 18 19 |
# File 'lib/files.com/models/notification.rb', line 17 def id=(value) @attributes[:id] = value end |
#notify_on_copy ⇒ Object
boolean - Triggers notification when moving or copying files to this path
58 59 60 |
# File 'lib/files.com/models/notification.rb', line 58 def notify_on_copy @attributes[:notify_on_copy] end |
#notify_on_copy=(value) ⇒ Object
62 63 64 |
# File 'lib/files.com/models/notification.rb', line 62 def notify_on_copy=(value) @attributes[:notify_on_copy] = value end |
#notify_user_actions ⇒ Object
boolean - Trigger notification on notification user actions?
49 50 51 |
# File 'lib/files.com/models/notification.rb', line 49 def notify_user_actions @attributes[:notify_user_actions] end |
#notify_user_actions=(value) ⇒ Object
53 54 55 |
# File 'lib/files.com/models/notification.rb', line 53 def notify_user_actions=(value) @attributes[:notify_user_actions] = value end |
#path ⇒ Object
string - Folder path to notify on 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/notification.rb', line 22 def path @attributes[:path] end |
#path=(value) ⇒ Object
26 27 28 |
# File 'lib/files.com/models/notification.rb', line 26 def path=(value) @attributes[:path] = value end |
#save ⇒ Object
149 150 151 152 153 154 155 156 |
# File 'lib/files.com/models/notification.rb', line 149 def save if @attributes[:id] update(@attributes) else new_obj = Notification.create(@attributes, @options) @attributes = new_obj.attributes end end |
#send_interval ⇒ Object
string - The time interval that notifications are aggregated to
67 68 69 |
# File 'lib/files.com/models/notification.rb', line 67 def send_interval @attributes[:send_interval] end |
#send_interval=(value) ⇒ Object
71 72 73 |
# File 'lib/files.com/models/notification.rb', line 71 def send_interval=(value) @attributes[:send_interval] = value end |
#suppressed_email ⇒ Object
boolean - If true, it means that the recipient at this user’s email address has manually unsubscribed from all emails, or had their email “hard bounce”, which means that we are unable to send mail to this user’s current email address. Notifications will resume if the user changes their email address.
112 113 114 |
# File 'lib/files.com/models/notification.rb', line 112 def suppressed_email @attributes[:suppressed_email] end |
#suppressed_email=(value) ⇒ Object
116 117 118 |
# File 'lib/files.com/models/notification.rb', line 116 def suppressed_email=(value) @attributes[:suppressed_email] = value end |
#unsubscribed ⇒ Object
boolean - Is the user unsubscribed from this notification?
76 77 78 |
# File 'lib/files.com/models/notification.rb', line 76 def unsubscribed @attributes[:unsubscribed] end |
#unsubscribed=(value) ⇒ Object
80 81 82 |
# File 'lib/files.com/models/notification.rb', line 80 def unsubscribed=(value) @attributes[:unsubscribed] = value end |
#unsubscribed_reason ⇒ Object
string - The reason that the user unsubscribed
85 86 87 |
# File 'lib/files.com/models/notification.rb', line 85 def unsubscribed_reason @attributes[:unsubscribed_reason] end |
#unsubscribed_reason=(value) ⇒ Object
89 90 91 |
# File 'lib/files.com/models/notification.rb', line 89 def unsubscribed_reason=(value) @attributes[:unsubscribed_reason] = value end |
#update(params = {}) ⇒ Object
Parameters:
notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
124 125 126 127 128 129 130 131 132 133 |
# File 'lib/files.com/models/notification.rb', line 124 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.dig(:id) and !params.dig(:id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: send_interval must be an String") if params.dig(:send_interval) and !params.dig(:send_interval).is_a?(String) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) Api.send_request("/notifications/#{@attributes[:id]}", :patch, params, @options) end |
#user_id ⇒ Object
int64 - Notification user ID
94 95 96 |
# File 'lib/files.com/models/notification.rb', line 94 def user_id @attributes[:user_id] end |
#user_id=(value) ⇒ Object
98 99 100 |
# File 'lib/files.com/models/notification.rb', line 98 def user_id=(value) @attributes[:user_id] = value end |
#username ⇒ Object
string - Notification username
103 104 105 |
# File 'lib/files.com/models/notification.rb', line 103 def username @attributes[:username] end |
#username=(value) ⇒ Object
107 108 109 |
# File 'lib/files.com/models/notification.rb', line 107 def username=(value) @attributes[:username] = value end |