Class: Files::BundleRecipient

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of BundleRecipient.



7
8
9
10
 
# File 'lib/files.com/models/bundle_recipient.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_recipient.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_recipient.rb', line 5

def options
  @options
end

Class Method Details

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



58
59
60
 
# File 'lib/files.com/models/bundle_recipient.rb', line 58

def self.all(params = {}, options = {})
  list(params, options)
end

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

Parameters:

user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
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.
cursor - string - Send cursor 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.
bundle_id (required) - int64 - List recipients for the bundle with this ID.

Raises:



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/files.com/models/bundle_recipient.rb', line 44

def self.list(params = {}, options = {})
  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: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: bundle_id") unless params.dig(:bundle_id)

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

Instance Method Details

#company ⇒ Object

string - The recipient’s company.



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

def company
  @attributes[:company]
end

#name ⇒ Object

string - The recipient’s name.



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

def name
  @attributes[:name]
end

#note ⇒ Object

string - A note sent to the recipient with the bundle.



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

def note
  @attributes[:note]
end

#recipient ⇒ Object

string - The recipient’s email address.



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

def recipient
  @attributes[:recipient]
end

#sent_at ⇒ Object

date-time - When the Bundle was shared with this recipient.



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

def sent_at
  @attributes[:sent_at]
end