Class: Files::BundleAction

Inherits:
Object
  • Object
show all
Defined in:
lib/files.com/models/bundle_action.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}, options = {}) ⇒ BundleAction

Returns a new instance of BundleAction.



7
8
9
10
 
# File 'lib/files.com/models/bundle_action.rb', line 7

def initialize(attributes = {}, options = {})
  @attributes = attributes || {}
  @options = options || {}
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



5
6
7
 
# File 'lib/files.com/models/bundle_action.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_action.rb', line 5

def options
  @options
end

Class Method Details

.all(params = {}, options = {}) ⇒ Object 



70
71
72
 
# File 'lib/files.com/models/bundle_action.rb', line 70

def self.all(params = {}, options = {})
  list(params, options)
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).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `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 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 the supplied value. Valid fields are `created_at`.
bundle_id - int64 - Bundle ID
bundle_registration_id - int64 - BundleRegistration ID

Raises:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/files.com/models/bundle_action.rb', line 53

def self.list(params = {}, options = {})
  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: 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)
  raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
  raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
  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: bundle_registration_id must be an Integer") if params[:bundle_registration_id] and !params[:bundle_registration_id].is_a?(Integer)

  List.new(BundleAction, params) do
    Api.send_request("/bundle_actions", :get, params, options)
  end
end

Instance Method Details

#action ⇒ Object

string - Type of action



13
14
15
 
# File 'lib/files.com/models/bundle_action.rb', line 13

def action
  @attributes[:action]
end

#bundle_registration ⇒ Object

BundleRegistration - Object that contains bundle registration information



18
19
20
 
# File 'lib/files.com/models/bundle_action.rb', line 18

def bundle_registration
  @attributes[:bundle_registration]
end

#destination ⇒ Object

string - The destination path for this bundle action, if applicable



28
29
30
 
# File 'lib/files.com/models/bundle_action.rb', line 28

def destination
  @attributes[:destination]
end

#path ⇒ Object

string - Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.



33
34
35
 
# File 'lib/files.com/models/bundle_action.rb', line 33

def path
  @attributes[:path]
end

#source ⇒ Object

string - The source path for this bundle action, if applicable



38
39
40
 
# File 'lib/files.com/models/bundle_action.rb', line 38

def source
  @attributes[:source]
end

#when ⇒ Object

date-time - Action occurrence date/time



23
24
25
 
# File 'lib/files.com/models/bundle_action.rb', line 23

def when
  @attributes[:when]
end