Class: Files::Bundle
- Inherits:
-
Object
- Object
- Files::Bundle
- Defined in:
- lib/files.com/models/bundle.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 - User ID.
- .delete(id, params = {}, options = {}) ⇒ Object
- .destroy(id, params = {}, options = {}) ⇒ Object
-
.find(id, params = {}, options = {}) ⇒ Object
Parameters: id (required) - int64 - Bundle ID.
- .get(id, params = {}, options = {}) ⇒ Object
-
.list(params = {}, options = {}) ⇒ Object
Parameters: user_id - int64 - User ID.
-
.share(id, params = {}, options = {}) ⇒ Object
Send email(s) with a link to bundle.
-
.update(id, params = {}, options = {}) ⇒ Object
Parameters: paths - array(string) - A list of paths to include in this bundle.
Instance Method Summary collapse
-
#clickwrap_body ⇒ Object
string - Legal text that must be agreed to prior to accessing Bundle.
- #clickwrap_body=(value) ⇒ Object
-
#clickwrap_id ⇒ Object
int64 - ID of the clickwrap to use with this bundle.
- #clickwrap_id=(value) ⇒ Object
-
#code ⇒ Object
string - Bundle code.
- #code=(value) ⇒ Object
-
#created_at ⇒ Object
date-time - Bundle created at date/time.
- #delete(params = {}) ⇒ Object
-
#description ⇒ Object
string - Public description.
- #description=(value) ⇒ Object
- #destroy(params = {}) ⇒ Object
-
#expires_at ⇒ Object
date-time - Bundle expiration date/time.
- #expires_at=(value) ⇒ Object
-
#form_field_set ⇒ Object
Custom Form to use.
- #form_field_set=(value) ⇒ Object
-
#form_field_set_id ⇒ Object
int64 - Id of Form Field Set to use with this bundle.
- #form_field_set_id=(value) ⇒ Object
-
#has_inbox ⇒ Object
boolean - Does this bundle have an associated inbox?.
- #has_inbox=(value) ⇒ Object
-
#id ⇒ Object
int64 - Bundle ID.
- #id=(value) ⇒ Object
-
#inbox_id ⇒ Object
int64 - ID of the associated inbox, if available.
- #inbox_id=(value) ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ Bundle
constructor
A new instance of Bundle.
-
#max_uses ⇒ Object
int64 - Maximum number of times bundle can be accessed.
- #max_uses=(value) ⇒ Object
-
#note ⇒ Object
string - Bundle internal note.
- #note=(value) ⇒ Object
-
#password ⇒ Object
string - Password for this bundle.
- #password=(value) ⇒ Object
-
#password_protected ⇒ Object
boolean - Is this bundle password protected?.
- #password_protected=(value) ⇒ Object
-
#paths ⇒ Object
array - A list of paths in this bundle.
- #paths=(value) ⇒ Object
-
#preview_only ⇒ Object
boolean - Restrict users to previewing files only?.
- #preview_only=(value) ⇒ Object
-
#require_registration ⇒ Object
boolean - Show a registration page that captures the downloader’s name and email address?.
- #require_registration=(value) ⇒ Object
-
#require_share_recipient ⇒ Object
boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?.
- #require_share_recipient=(value) ⇒ Object
- #save ⇒ Object
-
#share(params = {}) ⇒ Object
Send email(s) with a link to bundle.
-
#update(params = {}) ⇒ Object
Parameters: paths - array(string) - A list of paths to include in this bundle.
-
#url ⇒ Object
string - Public URL of Share Link.
- #url=(value) ⇒ Object
-
#user_id ⇒ Object
int64 - Bundle creator user ID.
- #user_id=(value) ⇒ Object
-
#username ⇒ Object
string - Bundle creator username.
- #username=(value) ⇒ Object
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ Bundle
Returns a new instance of Bundle.
7 8 9 10 |
# File 'lib/files.com/models/bundle.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.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.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
310 311 312 |
# File 'lib/files.com/models/bundle.rb', line 310 def self.all(params = {}, = {}) list(params, ) end |
.create(params = {}, options = {}) ⇒ Object
Parameters:
user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
paths (required) - array(string) - A list of paths to include in this bundle.
password - string - Password for this bundle.
form_field_set_id - int64 - Id of Form Field Set to use with this bundle
expires_at - string - Bundle expiration date/time
max_uses - int64 - Maximum number of times bundle can be accessed
description - string - Public description
note - string - Bundle internal note
code - string - Bundle code. This code forms the end part of the Public URL.
preview_only - boolean - Restrict users to previewing files only?
require_registration - boolean - Show a registration page that captures the downloader's name and email address?
clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
inbox_id - int64 - ID of the associated inbox, if available.
require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/files.com/models/bundle.rb', line 345 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: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array) raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String) raise InvalidParameterError.new("Bad parameter: form_field_set_id must be an Integer") if params.dig(:form_field_set_id) and !params.dig(:form_field_set_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String) raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String) raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String) raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String) raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer) raise MissingParameterError.new("Parameter missing: paths") unless params.dig(:paths) response, = Api.send_request("/bundles", :post, params, ) Bundle.new(response.data, ) end |
.delete(id, params = {}, options = {}) ⇒ Object
416 417 418 419 420 421 422 423 424 |
# File 'lib/files.com/models/bundle.rb', line 416 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("/bundles/#{params[:id]}", :delete, params, ) response.data end |
.destroy(id, params = {}, options = {}) ⇒ Object
426 427 428 |
# File 'lib/files.com/models/bundle.rb', line 426 def self.destroy(id, params = {}, = {}) delete(id, params, ) end |
.find(id, params = {}, options = {}) ⇒ Object
Parameters:
id (required) - int64 - Bundle ID.
316 317 318 319 320 321 322 323 324 |
# File 'lib/files.com/models/bundle.rb', line 316 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("/bundles/#{params[:id]}", :get, params, ) Bundle.new(response.data, ) end |
.get(id, params = {}, options = {}) ⇒ Object
326 327 328 |
# File 'lib/files.com/models/bundle.rb', line 326 def self.get(id, params = {}, = {}) find(id, params, ) end |
.list(params = {}, options = {}) ⇒ Object
Parameters:
user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `created_at` and `code`.
filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/files.com/models/bundle.rb', line 293 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: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String) 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: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash) raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash) List.new(Bundle, params) do Api.send_request("/bundles", :get, params, ) end end |
.share(id, params = {}, options = {}) ⇒ Object
Send email(s) with a link to bundle
Parameters:
to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
note - string - Note to include in email.
recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
369 370 371 372 373 374 375 376 377 378 379 380 |
# File 'lib/files.com/models/bundle.rb', line 369 def self.share(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: to must be an Array") if params.dig(:to) and !params.dig(:to).is_a?(Array) raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String) raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params.dig(:recipients) and !params.dig(:recipients).is_a?(Array) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) response, = Api.send_request("/bundles/#{params[:id]}/share", :post, params, ) response.data end |
.update(id, params = {}, options = {}) ⇒ Object
Parameters:
paths - array(string) - A list of paths to include in this bundle.
password - string - Password for this bundle.
form_field_set_id - int64 - Id of Form Field Set to use with this bundle
clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
code - string - Bundle code. This code forms the end part of the Public URL.
description - string - Public description
expires_at - string - Bundle expiration date/time
inbox_id - int64 - ID of the associated inbox, if available.
max_uses - int64 - Maximum number of times bundle can be accessed
note - string - Bundle internal note
preview_only - boolean - Restrict users to previewing files only?
require_registration - boolean - Show a registration page that captures the downloader's name and email address?
require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
# File 'lib/files.com/models/bundle.rb', line 396 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: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array) raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String) raise InvalidParameterError.new("Bad parameter: form_field_set_id must be an Integer") if params.dig(:form_field_set_id) and !params.dig(:form_field_set_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String) raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String) raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String) raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) response, = Api.send_request("/bundles/#{params[:id]}", :patch, params, ) Bundle.new(response.data, ) end |
Instance Method Details
#clickwrap_body ⇒ Object
string - Legal text that must be agreed to prior to accessing Bundle.
76 77 78 |
# File 'lib/files.com/models/bundle.rb', line 76 def clickwrap_body @attributes[:clickwrap_body] end |
#clickwrap_body=(value) ⇒ Object
80 81 82 |
# File 'lib/files.com/models/bundle.rb', line 80 def clickwrap_body=(value) @attributes[:clickwrap_body] = value end |
#clickwrap_id ⇒ Object
int64 - ID of the clickwrap to use with this bundle.
153 154 155 |
# File 'lib/files.com/models/bundle.rb', line 153 def clickwrap_id @attributes[:clickwrap_id] end |
#clickwrap_id=(value) ⇒ Object
157 158 159 |
# File 'lib/files.com/models/bundle.rb', line 157 def clickwrap_id=(value) @attributes[:clickwrap_id] = value end |
#code ⇒ Object
string - Bundle code. This code forms the end part of the Public URL.
13 14 15 |
# File 'lib/files.com/models/bundle.rb', line 13 def code @attributes[:code] end |
#code=(value) ⇒ Object
17 18 19 |
# File 'lib/files.com/models/bundle.rb', line 17 def code=(value) @attributes[:code] = value end |
#created_at ⇒ Object
date-time - Bundle created at date/time
103 104 105 |
# File 'lib/files.com/models/bundle.rb', line 103 def created_at @attributes[:created_at] end |
#delete(params = {}) ⇒ Object
259 260 261 262 263 264 265 266 267 |
# File 'lib/files.com/models/bundle.rb', line 259 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("/bundles/#{@attributes[:id]}", :delete, params, @options) end |
#description ⇒ Object
string - Public description
31 32 33 |
# File 'lib/files.com/models/bundle.rb', line 31 def description @attributes[:description] end |
#description=(value) ⇒ Object
35 36 37 |
# File 'lib/files.com/models/bundle.rb', line 35 def description=(value) @attributes[:description] = value end |
#destroy(params = {}) ⇒ Object
269 270 271 |
# File 'lib/files.com/models/bundle.rb', line 269 def destroy(params = {}) delete(params) end |
#expires_at ⇒ Object
date-time - Bundle expiration date/time
108 109 110 |
# File 'lib/files.com/models/bundle.rb', line 108 def expires_at @attributes[:expires_at] end |
#expires_at=(value) ⇒ Object
112 113 114 |
# File 'lib/files.com/models/bundle.rb', line 112 def expires_at=(value) @attributes[:expires_at] = value end |
#form_field_set ⇒ Object
Custom Form to use
85 86 87 |
# File 'lib/files.com/models/bundle.rb', line 85 def form_field_set @attributes[:form_field_set] end |
#form_field_set=(value) ⇒ Object
89 90 91 |
# File 'lib/files.com/models/bundle.rb', line 89 def form_field_set=(value) @attributes[:form_field_set] = value end |
#form_field_set_id ⇒ Object
int64 - Id of Form Field Set to use with this bundle
198 199 200 |
# File 'lib/files.com/models/bundle.rb', line 198 def form_field_set_id @attributes[:form_field_set_id] end |
#form_field_set_id=(value) ⇒ Object
202 203 204 |
# File 'lib/files.com/models/bundle.rb', line 202 def form_field_set_id=(value) @attributes[:form_field_set_id] = value end |
#has_inbox ⇒ Object
boolean - Does this bundle have an associated inbox?
171 172 173 |
# File 'lib/files.com/models/bundle.rb', line 171 def has_inbox @attributes[:has_inbox] end |
#has_inbox=(value) ⇒ Object
175 176 177 |
# File 'lib/files.com/models/bundle.rb', line 175 def has_inbox=(value) @attributes[:has_inbox] = value end |
#id ⇒ Object
int64 - Bundle ID
94 95 96 |
# File 'lib/files.com/models/bundle.rb', line 94 def id @attributes[:id] end |
#id=(value) ⇒ Object
98 99 100 |
# File 'lib/files.com/models/bundle.rb', line 98 def id=(value) @attributes[:id] = value end |
#inbox_id ⇒ Object
int64 - ID of the associated inbox, if available.
162 163 164 |
# File 'lib/files.com/models/bundle.rb', line 162 def inbox_id @attributes[:inbox_id] end |
#inbox_id=(value) ⇒ Object
166 167 168 |
# File 'lib/files.com/models/bundle.rb', line 166 def inbox_id=(value) @attributes[:inbox_id] = value end |
#max_uses ⇒ Object
int64 - Maximum number of times bundle can be accessed
117 118 119 |
# File 'lib/files.com/models/bundle.rb', line 117 def max_uses @attributes[:max_uses] end |
#max_uses=(value) ⇒ Object
121 122 123 |
# File 'lib/files.com/models/bundle.rb', line 121 def max_uses=(value) @attributes[:max_uses] = value end |
#note ⇒ Object
string - Bundle internal note
126 127 128 |
# File 'lib/files.com/models/bundle.rb', line 126 def note @attributes[:note] end |
#note=(value) ⇒ Object
130 131 132 |
# File 'lib/files.com/models/bundle.rb', line 130 def note=(value) @attributes[:note] = value end |
#password ⇒ Object
string - Password for this bundle.
189 190 191 |
# File 'lib/files.com/models/bundle.rb', line 189 def password @attributes[:password] end |
#password=(value) ⇒ Object
193 194 195 |
# File 'lib/files.com/models/bundle.rb', line 193 def password=(value) @attributes[:password] = value end |
#password_protected ⇒ Object
boolean - Is this bundle password protected?
40 41 42 |
# File 'lib/files.com/models/bundle.rb', line 40 def password_protected @attributes[:password_protected] end |
#password_protected=(value) ⇒ Object
44 45 46 |
# File 'lib/files.com/models/bundle.rb', line 44 def password_protected=(value) @attributes[:password_protected] = value end |
#paths ⇒ Object
array - A list of paths in this bundle
180 181 182 |
# File 'lib/files.com/models/bundle.rb', line 180 def paths @attributes[:paths] end |
#paths=(value) ⇒ Object
184 185 186 |
# File 'lib/files.com/models/bundle.rb', line 184 def paths=(value) @attributes[:paths] = value end |
#preview_only ⇒ Object
boolean - Restrict users to previewing files only?
49 50 51 |
# File 'lib/files.com/models/bundle.rb', line 49 def preview_only @attributes[:preview_only] end |
#preview_only=(value) ⇒ Object
53 54 55 |
# File 'lib/files.com/models/bundle.rb', line 53 def preview_only=(value) @attributes[:preview_only] = value end |
#require_registration ⇒ Object
boolean - Show a registration page that captures the downloader’s name and email address?
58 59 60 |
# File 'lib/files.com/models/bundle.rb', line 58 def require_registration @attributes[:require_registration] end |
#require_registration=(value) ⇒ Object
62 63 64 |
# File 'lib/files.com/models/bundle.rb', line 62 def require_registration=(value) @attributes[:require_registration] = value end |
#require_share_recipient ⇒ Object
boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
67 68 69 |
# File 'lib/files.com/models/bundle.rb', line 67 def require_share_recipient @attributes[:require_share_recipient] end |
#require_share_recipient=(value) ⇒ Object
71 72 73 |
# File 'lib/files.com/models/bundle.rb', line 71 def require_share_recipient=(value) @attributes[:require_share_recipient] = value end |
#save ⇒ Object
273 274 275 276 277 278 279 280 |
# File 'lib/files.com/models/bundle.rb', line 273 def save if @attributes[:id] update(@attributes) else new_obj = Bundle.create(@attributes, @options) @attributes = new_obj.attributes end end |
#share(params = {}) ⇒ Object
Send email(s) with a link to bundle
Parameters:
to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
note - string - Note to include in email.
recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/files.com/models/bundle.rb', line 212 def share(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: to must be an Array") if params.dig(:to) and !params.dig(:to).is_a?(Array) raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String) raise InvalidParameterError.new("Bad parameter: recipients must be an Array") if params.dig(:recipients) and !params.dig(:recipients).is_a?(Array) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) Api.send_request("/bundles/#{@attributes[:id]}/share", :post, params, @options) end |
#update(params = {}) ⇒ Object
Parameters:
paths - array(string) - A list of paths to include in this bundle.
password - string - Password for this bundle.
form_field_set_id - int64 - Id of Form Field Set to use with this bundle
clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
code - string - Bundle code. This code forms the end part of the Public URL.
description - string - Public description
expires_at - string - Bundle expiration date/time
inbox_id - int64 - ID of the associated inbox, if available.
max_uses - int64 - Maximum number of times bundle can be accessed
note - string - Bundle internal note
preview_only - boolean - Restrict users to previewing files only?
require_registration - boolean - Show a registration page that captures the downloader's name and email address?
require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/files.com/models/bundle.rb', line 239 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: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array) raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String) raise InvalidParameterError.new("Bad parameter: form_field_set_id must be an Integer") if params.dig(:form_field_set_id) and !params.dig(:form_field_set_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String) raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String) raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String) raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params.dig(:max_uses) and !params.dig(:max_uses).is_a?(Integer) raise InvalidParameterError.new("Bad parameter: note must be an String") if params.dig(:note) and !params.dig(:note).is_a?(String) raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id) Api.send_request("/bundles/#{@attributes[:id]}", :patch, params, @options) end |
#url ⇒ Object
string - Public URL of Share Link
22 23 24 |
# File 'lib/files.com/models/bundle.rb', line 22 def url @attributes[:url] end |
#url=(value) ⇒ Object
26 27 28 |
# File 'lib/files.com/models/bundle.rb', line 26 def url=(value) @attributes[:url] = value end |
#user_id ⇒ Object
int64 - Bundle creator user ID
135 136 137 |
# File 'lib/files.com/models/bundle.rb', line 135 def user_id @attributes[:user_id] end |
#user_id=(value) ⇒ Object
139 140 141 |
# File 'lib/files.com/models/bundle.rb', line 139 def user_id=(value) @attributes[:user_id] = value end |
#username ⇒ Object
string - Bundle creator username
144 145 146 |
# File 'lib/files.com/models/bundle.rb', line 144 def username @attributes[:username] end |
#username=(value) ⇒ Object
148 149 150 |
# File 'lib/files.com/models/bundle.rb', line 148 def username=(value) @attributes[:username] = value end |