Class: Files::InboxUpload
- Inherits:
-
Object
- Object
- Files::InboxUpload
- Defined in:
- lib/files.com/models/inbox_upload.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
-
.list(params = {}, options = {}) ⇒ Object
Parameters: cursor - string - Used for pagination.
Instance Method Summary collapse
-
#created_at ⇒ Object
date-time - Upload date/time.
- #inbox_registration ⇒ Object
-
#initialize(attributes = {}, options = {}) ⇒ InboxUpload
constructor
A new instance of InboxUpload.
-
#path ⇒ Object
string - Upload path This must be slash-delimited, but it must neither start nor end with a slash.
Constructor Details
#initialize(attributes = {}, options = {}) ⇒ InboxUpload
Returns a new instance of InboxUpload.
7 8 9 10 |
# File 'lib/files.com/models/inbox_upload.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/inbox_upload.rb', line 5 def attributes @attributes end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
5 6 7 |
# File 'lib/files.com/models/inbox_upload.rb', line 5 def @options end |
Class Method Details
.all(params = {}, options = {}) ⇒ Object
56 57 58 |
# File 'lib/files.com/models/inbox_upload.rb', line 56 def self.all(params = {}, = {}) list(params, ) end |
.list(params = {}, options = {}) ⇒ Object
Parameters:
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`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`.
filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`.
inbox_registration_id - int64 - InboxRegistration ID
inbox_id - int64 - Inbox ID
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/files.com/models/inbox_upload.rb', line 38 def self.list(params = {}, = {}) 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) raise InvalidParameterError.new("Bad parameter: inbox_registration_id must be an Integer") if params.dig(:inbox_registration_id) and !params.dig(:inbox_registration_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) List.new(InboxUpload, params) do Api.send_request("/inbox_uploads", :get, params, ) end end |
Instance Method Details
#created_at ⇒ Object
date-time - Upload date/time
22 23 24 |
# File 'lib/files.com/models/inbox_upload.rb', line 22 def created_at @attributes[:created_at] end |
#inbox_registration ⇒ Object
12 13 14 |
# File 'lib/files.com/models/inbox_upload.rb', line 12 def inbox_registration @attributes[:inbox_registration] end |
#path ⇒ Object
string - Upload path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
17 18 19 |
# File 'lib/files.com/models/inbox_upload.rb', line 17 def path @attributes[:path] end |