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 



109
110
111
 
# File 'lib/files.com/models/bundle_recipient.rb', line 109

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

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

Parameters:

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:



120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/files.com/models/bundle_recipient.rb', line 120

def self.create(params = {}, options = {})
  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: recipient must be an String") if params[:recipient] and !params[:recipient].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: company must be an String") if params[:company] and !params[:company].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: note must be an String") if params[:note] and !params[:note].is_a?(String)
  raise MissingParameterError.new("Parameter missing: bundle_id") unless params[:bundle_id]
  raise MissingParameterError.new("Parameter missing: recipient") unless params[:recipient]

  response, options = Api.send_request("/bundle_recipients", :post, params, options)
  BundleRecipient.new(response.data, 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).
action - string
page - int64
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[has_registrations]=desc`). Valid fields are `has_registrations`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
bundle_id (required) - int64 - List recipients for the bundle with this ID.

Raises:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/files.com/models/bundle_recipient.rb', line 94

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: action must be an String") if params[:action] and !params[:action].is_a?(String)
  raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[: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: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: bundle_id") unless params[: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.



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

def bundle_id
  @attributes[:bundle_id]
end

#bundle_id=(value) ⇒ Object 



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

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 



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/files.com/models/bundle_recipient.rb', line 75

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

  @attributes = new_obj.attributes
  true
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.



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

def share_after_create
  @attributes[:share_after_create]
end

#share_after_create=(value) ⇒ Object 



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

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