Class: Files::UserAdditionalEmailRecipient

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of UserAdditionalEmailRecipient.



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

def options
  @options
end

Class Method Details

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



112
113
114
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 112

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.
email (required) - string - Additional email recipient address

Raises:



135
136
137
138
139
140
141
142
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 135

def self.create(params = {}, options = {})
  raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
  raise MissingParameterError.new("Parameter missing: email") unless params[:email]

  response, options = Api.send_request("/user_additional_email_recipients", :post, params, options)
  UserAdditionalEmailRecipient.new(response.data, options)
end

.delete(id, params = {}, options = {}) ⇒ Object

Raises:



157
158
159
160
161
162
163
164
165
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 157

def self.delete(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/user_additional_email_recipients/#{params[:id]}", :delete, params, options)
  nil
end

.destroy(id, params = {}, options = {}) ⇒ Object 



167
168
169
170
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 167

def self.destroy(id, params = {}, options = {})
  delete(id, params, options)
  nil
end

.find(id, params = {}, options = {}) ⇒ Object

Parameters:

id (required) - int64 - User Additional Email Recipient ID.

Raises:



118
119
120
121
122
123
124
125
126
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 118

def self.find(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/user_additional_email_recipients/#{params[:id]}", :get, params, options)
  UserAdditionalEmailRecipient.new(response.data, options)
end

.get(id, params = {}, options = {}) ⇒ Object 



128
129
130
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 128

def self.get(id, params = {}, options = {})
  find(id, 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.
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: 10000, 1,000 or less is recommended).
sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `email`, `user_id` or `workspace_id`.
filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `email` and `workspace_id`. Valid field combinations are `[ workspace_id, email ]`.
filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `email`.

Raises:



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 99

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

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

.update(id, params = {}, options = {}) ⇒ Object

Parameters:

email - string - Additional email recipient address

Raises:



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 146

def self.update(id, params = {}, options = {})
  params ||= {}
  params[:id] = id
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  response, options = Api.send_request("/user_additional_email_recipients/#{params[:id]}", :patch, params, options)
  UserAdditionalEmailRecipient.new(response.data, options)
end

Instance Method Details

#created_at ⇒ Object

date-time - Created at date/time



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

def created_at
  @attributes[:created_at]
end

#delete(params = {}) ⇒ Object

Raises:



66
67
68
69
70
71
72
73
74
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 66

def delete(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/user_additional_email_recipients/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



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

def destroy(params = {})
  delete(params)
  nil
end

#email ⇒ Object

string - Additional email recipient address



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

def email
  @attributes[:email]
end

#email=(value) ⇒ Object 



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

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

#id ⇒ Object

int64 - User additional email recipient ID



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



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

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

#save ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 81

def save
  if @attributes[:id]
    new_obj = update(@attributes)
  else
    new_obj = UserAdditionalEmailRecipient.create(@attributes, @options)
  end

  @attributes = new_obj.attributes
  true
end

#update(params = {}) ⇒ Object

Parameters:

email - string - Additional email recipient address

Raises:



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/files.com/models/user_additional_email_recipient.rb', line 55

def update(params = {})
  params ||= {}
  params[:id] = @attributes[:id]
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
  raise InvalidParameterError.new("Bad parameter: email must be an String") if params[:email] and !params[:email].is_a?(String)
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]

  Api.send_request("/user_additional_email_recipients/#{@attributes[:id]}", :patch, params, @options)
end

#user_id ⇒ Object

int64 - User ID



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

def user_id
  @attributes[:user_id]
end

#user_id=(value) ⇒ Object 



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

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

#workspace_id ⇒ Object

int64 - Workspace ID (0 for default workspace).



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

def workspace_id
  @attributes[:workspace_id]
end

#workspace_id=(value) ⇒ Object 



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

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