Class: Files::Message

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Message.



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

def attributes
  @attributes
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



5
6
7
 
# File 'lib/files.com/models/message.rb', line 5

def options
  @options
end

Class Method Details

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



129
130
131
 
# File 'lib/files.com/models/message.rb', line 129

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.
project_id (required) - int64 - Project to which the message should be attached.
subject (required) - string - Message subject.
body (required) - string - Message body.

Raises:



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

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

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

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

Raises:



187
188
189
190
191
192
193
194
195
 
# File 'lib/files.com/models/message.rb', line 187

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("/messages/#{params[:id]}", :delete, params, options)
  nil
end

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



197
198
199
200
 
# File 'lib/files.com/models/message.rb', line 197

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

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

Parameters:

id (required) - int64 - Message ID.

Raises:



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

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("/messages/#{params[:id]}", :get, params, options)
  Message.new(response.data, options)
end

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



145
146
147
 
# File 'lib/files.com/models/message.rb', line 145

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: 10,000, 1,000 or less is recommended).
project_id (required) - int64 - Project for which to return messages.

Raises:



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

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: project_id must be an Integer") if params[:project_id] and !params[:project_id].is_a?(Integer)
  raise MissingParameterError.new("Parameter missing: project_id") unless params[:project_id]

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

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

Parameters:

project_id (required) - int64 - Project to which the message should be attached.
subject (required) - string - Message subject.
body (required) - string - Message body.

Raises:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/files.com/models/message.rb', line 171

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

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

Instance Method Details

#body ⇒ Object

string - Message body.



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

def body
  @attributes[:body]
end

#body=(value) ⇒ Object 



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

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

#comments ⇒ Object

array - Comments.



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

def comments
  @attributes[:comments]
end

#comments=(value) ⇒ Object 



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

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

#delete(params = {}) ⇒ Object

Raises:



86
87
88
89
90
91
92
93
94
 
# File 'lib/files.com/models/message.rb', line 86

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("/messages/#{@attributes[:id]}", :delete, params, @options)
end

#destroy(params = {}) ⇒ Object 



96
97
98
99
 
# File 'lib/files.com/models/message.rb', line 96

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

#id ⇒ Object

int64 - Message ID



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

def id
  @attributes[:id]
end

#id=(value) ⇒ Object 



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

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

#project_id ⇒ Object

int64 - Project to which the message should be attached.



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

def project_id
  @attributes[:project_id]
end

#project_id=(value) ⇒ Object 



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

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

#save ⇒ Object 



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

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

  @attributes = new_obj.attributes
  true
end

#subject ⇒ Object

string - Message subject.



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

def subject
  @attributes[:subject]
end

#subject=(value) ⇒ Object 



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

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

#update(params = {}) ⇒ Object

Parameters:

project_id (required) - int64 - Project to which the message should be attached.
subject (required) - string - Message subject.
body (required) - string - Message body.

Raises:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/files.com/models/message.rb', line 70

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

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

#user_id ⇒ Object

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



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

def user_id
  @attributes[:user_id]
end

#user_id=(value) ⇒ Object 



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

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