Class: Files::BundleNotification
- Inherits:
-
Object
- Object
- Files::BundleNotification
- Defined in:
- lib/files.com/models/bundle_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: bundle_id (required) - int64 - Bundle ID to notify on 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 - Bundle Notification ID.
- .get(id, params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
-
.update(id, params = {}, options = {}) ⇒ Object
Parameters: notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
Instance Method Summary collapse
-
#bundle_id ⇒ Object
int64 - Bundle ID to notify on.
- #bundle_id=(value) ⇒ Object
- #delete(params = {}) ⇒ Object
- #destroy(params = {}) ⇒ Object
-
#id ⇒ Object
int64 - Bundle Notification ID.
- #id=(value) ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ BundleNotification
constructor
A new instance of BundleNotification.
-
#notify_on_registration ⇒ Object
boolean - Triggers bundle notification when a registration action occurs for it.
- #notify_on_registration=(value) ⇒ Object
-
#notify_on_upload ⇒ Object
boolean - Triggers bundle notification when a upload action occurs for it.
- #notify_on_upload=(value) ⇒ Object
- #save ⇒ Object
-
#update(params = {}) ⇒ Object
Parameters: notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
-
#user_id ⇒ Object
int64 - The id of the user to notify.
- #user_id=(value) ⇒ Object
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ BundleNotification
Returns a new instance of BundleNotification.
7 8 9 10 |
# File 'lib/files.com/models/bundle_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/bundle_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/bundle_notification.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
116 117 118 |
# File 'lib/files.com/models/bundle_notification.rb', line 116 def self.all(params = {}, = {}) list(params, ) end |
.create(params = {}, options = {}) ⇒ Object
Parameters:
bundle_id (required) - int64 - Bundle ID to notify on
user_id - int64 - The id of the user to notify.
notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
141 142 143 144 145 146 147 148 |
# File 'lib/files.com/models/bundle_notification.rb', line 141 def self.create(params = {}, = {}) raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer) raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer) raise MissingParameterError.new("Parameter missing: bundle_id") unless params[:bundle_id] response, = Api.send_request("/bundle_notifications", :post, params, ) BundleNotification.new(response.data, ) end |
.delete(id, params = {}, options = {}) ⇒ Object
163 164 165 166 167 168 169 170 171 |
# File 'lib/files.com/models/bundle_notification.rb', line 163 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("/bundle_notifications/#{params[:id]}", :delete, params, ) nil end |
.destroy(id, params = {}, options = {}) ⇒ Object
173 174 175 176 |
# File 'lib/files.com/models/bundle_notification.rb', line 173 def self.destroy(id, params = {}, = {}) delete(id, params, ) nil end |
.find(id, params = {}, options = {}) ⇒ Object
Parameters:
id (required) - int64 - Bundle Notification ID.
122 123 124 125 126 127 128 129 130 |
# File 'lib/files.com/models/bundle_notification.rb', line 122 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("/bundle_notifications/#{params[:id]}", :get, params, ) BundleNotification.new(response.data, ) end |
.get(id, params = {}, options = {}) ⇒ Object
132 133 134 |
# File 'lib/files.com/models/bundle_notification.rb', line 132 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
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_id]=desc`). Valid fields are `bundle_id`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/files.com/models/bundle_notification.rb', line 103 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) raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash) List.new(BundleNotification, params) do Api.send_request("/bundle_notifications", :get, params, ) end end |
.update(id, params = {}, options = {}) ⇒ Object
Parameters:
notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
153 154 155 156 157 158 159 160 161 |
# File 'lib/files.com/models/bundle_notification.rb', line 153 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 MissingParameterError.new("Parameter missing: id") unless params[:id] response, = Api.send_request("/bundle_notifications/#{params[:id]}", :patch, params, ) BundleNotification.new(response.data, ) end |
Instance Method Details
#bundle_id ⇒ Object
int64 - Bundle ID to notify on
13 14 15 |
# File 'lib/files.com/models/bundle_notification.rb', line 13 def bundle_id @attributes[:bundle_id] end |
#bundle_id=(value) ⇒ Object
17 18 19 |
# File 'lib/files.com/models/bundle_notification.rb', line 17 def bundle_id=(value) @attributes[:bundle_id] = value end |
#delete(params = {}) ⇒ Object
70 71 72 73 74 75 76 77 78 |
# File 'lib/files.com/models/bundle_notification.rb', line 70 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("/bundle_notifications/#{@attributes[:id]}", :delete, params, @options) end |
#destroy(params = {}) ⇒ Object
80 81 82 83 |
# File 'lib/files.com/models/bundle_notification.rb', line 80 def destroy(params = {}) delete(params) nil end |
#id ⇒ Object
int64 - Bundle Notification ID
22 23 24 |
# File 'lib/files.com/models/bundle_notification.rb', line 22 def id @attributes[:id] end |
#id=(value) ⇒ Object
26 27 28 |
# File 'lib/files.com/models/bundle_notification.rb', line 26 def id=(value) @attributes[:id] = value end |
#notify_on_registration ⇒ Object
boolean - Triggers bundle notification when a registration action occurs for it.
31 32 33 |
# File 'lib/files.com/models/bundle_notification.rb', line 31 def notify_on_registration @attributes[:notify_on_registration] end |
#notify_on_registration=(value) ⇒ Object
35 36 37 |
# File 'lib/files.com/models/bundle_notification.rb', line 35 def notify_on_registration=(value) @attributes[:notify_on_registration] = value end |
#notify_on_upload ⇒ Object
boolean - Triggers bundle notification when a upload action occurs for it.
40 41 42 |
# File 'lib/files.com/models/bundle_notification.rb', line 40 def notify_on_upload @attributes[:notify_on_upload] end |
#notify_on_upload=(value) ⇒ Object
44 45 46 |
# File 'lib/files.com/models/bundle_notification.rb', line 44 def notify_on_upload=(value) @attributes[:notify_on_upload] = value end |
#save ⇒ Object
85 86 87 88 89 90 91 92 93 94 |
# File 'lib/files.com/models/bundle_notification.rb', line 85 def save if @attributes[:id] new_obj = update(@attributes) else new_obj = BundleNotification.create(@attributes, @options) end @attributes = new_obj.attributes true end |
#update(params = {}) ⇒ Object
Parameters:
notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
60 61 62 63 64 65 66 67 68 |
# File 'lib/files.com/models/bundle_notification.rb', line 60 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 MissingParameterError.new("Parameter missing: id") unless params[:id] Api.send_request("/bundle_notifications/#{@attributes[:id]}", :patch, params, @options) end |
#user_id ⇒ Object
int64 - The id of the user to notify.
49 50 51 |
# File 'lib/files.com/models/bundle_notification.rb', line 49 def user_id @attributes[:user_id] end |
#user_id=(value) ⇒ Object
53 54 55 |
# File 'lib/files.com/models/bundle_notification.rb', line 53 def user_id=(value) @attributes[:user_id] = value end |