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 



124
125
126
 
# File 'lib/files.com/models/bundle_recipient.rb', line 124

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

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

Parameters:

user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
bundle_id (required) - int64 - Bundle to share.
recipient (required) - string - Email addresses to share this bundle with.
name - string - Name of recipient.
company - string - Company of recipient.
note - string - Note to include in email.
share_after_create - boolean - Set to true to share the link with the recipient upon creation.

Raises:



136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/files.com/models/bundle_recipient.rb', line 136

def self.create(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: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: recipient must be an String") if params.dig(:recipient) and !params.dig(:recipient).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
  raise InvalidParameterError.new("Bad parameter: company must be an String") if params.dig(:company) and !params.dig(:company).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 MissingParameterError.new("Parameter missing: bundle_id") unless params.dig(:bundle_id)
  raise MissingParameterError.new("Parameter missing: recipient") unless params.dig(:recipient)

  response, options = Api.send_request("/bundle_recipients", :post, params, options)
  BundleRecipient.new(response.data, options)
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 `has_registrations`.
filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `has_registrations`.
filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `has_registrations`.
filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `has_registrations`.
filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `has_registrations`.
bundle_id (required) - int64 - List recipients for the bundle with this ID.

Raises:



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/files.com/models/bundle_recipient.rb', line 105

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: 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: 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

#bundle_id ⇒ Object

int64 - Bundle to share.



67
68
69
 
# File 'lib/files.com/models/bundle_recipient.rb', line 67

def bundle_id
  @attributes[:bundle_id]
end

#bundle_id=(value) ⇒ Object 



71
72
73
 
# File 'lib/files.com/models/bundle_recipient.rb', line 71

def bundle_id=(value)
  @attributes[:bundle_id] = value
end

#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

#company=(value) ⇒ Object 



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

def company=(value)
  @attributes[:company] = value
end

#name ⇒ Object

string - The recipient’s name.



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

def name
  @attributes[:name]
end

#name=(value) ⇒ Object 



26
27
28
 
# File 'lib/files.com/models/bundle_recipient.rb', line 26

def name=(value)
  @attributes[:name] = value
end

#note ⇒ Object

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



31
32
33
 
# File 'lib/files.com/models/bundle_recipient.rb', line 31

def note
  @attributes[:note]
end

#note=(value) ⇒ Object 



35
36
37
 
# File 'lib/files.com/models/bundle_recipient.rb', line 35

def note=(value)
  @attributes[:note] = value
end

#recipient ⇒ Object

string - The recipient’s email address.



40
41
42
 
# File 'lib/files.com/models/bundle_recipient.rb', line 40

def recipient
  @attributes[:recipient]
end

#recipient=(value) ⇒ Object 



44
45
46
 
# File 'lib/files.com/models/bundle_recipient.rb', line 44

def recipient=(value)
  @attributes[:recipient] = value
end

#save ⇒ Object 



84
85
86
87
88
89
90
91
 
# File 'lib/files.com/models/bundle_recipient.rb', line 84

def save
  if @attributes[:id]
    raise NotImplementedError.new("The BundleRecipient object doesn't support updates.")
  else
    new_obj = BundleRecipient.create(@attributes, @options)
    @attributes = new_obj.attributes
  end
end

#sent_at ⇒ Object

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



49
50
51
 
# File 'lib/files.com/models/bundle_recipient.rb', line 49

def sent_at
  @attributes[:sent_at]
end

#sent_at=(value) ⇒ Object 



53
54
55
 
# File 'lib/files.com/models/bundle_recipient.rb', line 53

def sent_at=(value)
  @attributes[:sent_at] = value
end

#share_after_create ⇒ Object

boolean - Set to true to share the link with the recipient upon creation.



76
77
78
 
# File 'lib/files.com/models/bundle_recipient.rb', line 76

def share_after_create
  @attributes[:share_after_create]
end

#share_after_create=(value) ⇒ Object 



80
81
82
 
# File 'lib/files.com/models/bundle_recipient.rb', line 80

def share_after_create=(value)
  @attributes[:share_after_create] = value
end

#user_id ⇒ Object

int64 - User ID. Provide a value of ‘0` to operate the current session’s user.



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

def user_id
  @attributes[:user_id]
end

#user_id=(value) ⇒ Object 



62
63
64
 
# File 'lib/files.com/models/bundle_recipient.rb', line 62

def user_id=(value)
  @attributes[:user_id] = value
end