Class: Shortcut::ThreadedComment

Inherits:
Object
  • Object
show all
Defined in:
lib/shortcut_client_ruby/models/threaded_comment.rb

Overview

Comments associated with Epic Discussions.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ThreadedComment

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 103

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shortcut::ThreadedComment` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Shortcut::ThreadedComment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'app_url')
    self.app_url = attributes[:'app_url']
  end

  if attributes.key?(:'entity_type')
    self.entity_type = attributes[:'entity_type']
  end

  if attributes.key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.key?(:'mention_ids')
    if (value = attributes[:'mention_ids']).is_a?(Array)
      self.mention_ids = value
    end
  end

  if attributes.key?(:'author_id')
    self.author_id = attributes[:'author_id']
  end

  if attributes.key?(:'member_mention_ids')
    if (value = attributes[:'member_mention_ids']).is_a?(Array)
      self.member_mention_ids = value
    end
  end

  if attributes.key?(:'comments')
    if (value = attributes[:'comments']).is_a?(Array)
      self.comments = value
    end
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

  if attributes.key?(:'group_mention_ids')
    if (value = attributes[:'group_mention_ids']).is_a?(Array)
      self.group_mention_ids = value
    end
  end

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'text')
    self.text = attributes[:'text']
  end
end

Instance Attribute Details

#app_url ⇒ Object

The Shortcut application url for the Comment.



18
19
20
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 18

def app_url
  @app_url
end

#author_id ⇒ Object

The unique ID of the Member that authored the Comment.



30
31
32
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 30

def author_id
  @author_id
end

#comments ⇒ Object

A nested array of threaded comments.



36
37
38
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 36

def comments
  @comments
end

#created_at ⇒ Object

The time/date the Comment was created.



51
52
53
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 51

def created_at
  @created_at
end

#deleted ⇒ Object

True/false boolean indicating whether the Comment is deleted.



24
25
26
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 24

def deleted
  @deleted
end

#entity_type ⇒ Object

A string description of this resource.



21
22
23
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 21

def entity_type
  @entity_type
end

#external_id ⇒ Object

This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here.



45
46
47
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 45

def external_id
  @external_id
end

#group_mention_ids ⇒ Object

An array of Group IDs that have been mentioned in this Comment.



42
43
44
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 42

def group_mention_ids
  @group_mention_ids
end

#id ⇒ Object

The unique ID of the Comment.



48
49
50
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 48

def id
  @id
end

#member_mention_ids ⇒ Object

An array of Member IDs that have been mentioned in this Comment.



33
34
35
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 33

def member_mention_ids
  @member_mention_ids
end

#mention_ids ⇒ Object

Deprecated: use member_mention_ids.



27
28
29
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 27

def mention_ids
  @mention_ids
end

#text ⇒ Object

The text of the Comment.



54
55
56
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 54

def text
  @text
end

#updated_at ⇒ Object

The time/date the Comment was updated.



39
40
41
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 39

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 57

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'entity_type' => :'entity_type',
    :'deleted' => :'deleted',
    :'mention_ids' => :'mention_ids',
    :'author_id' => :'author_id',
    :'member_mention_ids' => :'member_mention_ids',
    :'comments' => :'comments',
    :'updated_at' => :'updated_at',
    :'group_mention_ids' => :'group_mention_ids',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'text' => :'text'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



290
291
292
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 290

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
99
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 95

def self.openapi_nullable
  Set.new([
    :'external_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 76

def self.openapi_types
  {
    :'app_url' => :'Object',
    :'entity_type' => :'Object',
    :'deleted' => :'Object',
    :'mention_ids' => :'Object',
    :'author_id' => :'Object',
    :'member_mention_ids' => :'Object',
    :'comments' => :'Object',
    :'updated_at' => :'Object',
    :'group_mention_ids' => :'Object',
    :'external_id' => :'Object',
    :'id' => :'Object',
    :'created_at' => :'Object',
    :'text' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 257

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_url == o.app_url &&
      entity_type == o.entity_type &&
      deleted == o.deleted &&
      mention_ids == o.mention_ids &&
      author_id == o.author_id &&
      member_mention_ids == o.member_mention_ids &&
      comments == o.comments &&
      updated_at == o.updated_at &&
      group_mention_ids == o.group_mention_ids &&
      external_id == o.external_id &&
      id == o.id &&
      created_at == o.created_at &&
      text == o.text
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 320

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    Shortcut.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 389

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 297

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


277
278
279
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 277

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



283
284
285
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 283

def hash
  [app_url, entity_type, deleted, mention_ids, author_id, member_mention_ids, comments, updated_at, group_mention_ids, external_id, id, created_at, text].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  if @app_url.nil?
    invalid_properties.push('invalid value for "app_url", app_url cannot be nil.')
  end

  if @entity_type.nil?
    invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.')
  end

  if @deleted.nil?
    invalid_properties.push('invalid value for "deleted", deleted cannot be nil.')
  end

  if @mention_ids.nil?
    invalid_properties.push('invalid value for "mention_ids", mention_ids cannot be nil.')
  end

  if @author_id.nil?
    invalid_properties.push('invalid value for "author_id", author_id cannot be nil.')
  end

  if @member_mention_ids.nil?
    invalid_properties.push('invalid value for "member_mention_ids", member_mention_ids cannot be nil.')
  end

  if @comments.nil?
    invalid_properties.push('invalid value for "comments", comments cannot be nil.')
  end

  if @updated_at.nil?
    invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
  end

  if @group_mention_ids.nil?
    invalid_properties.push('invalid value for "group_mention_ids", group_mention_ids cannot be nil.')
  end

  if @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @text.nil?
    invalid_properties.push('invalid value for "text", text cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



365
366
367
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 365

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 371

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



359
360
361
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 359

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/shortcut_client_ruby/models/threaded_comment.rb', line 238

def valid?
  return false if @app_url.nil?
  return false if @entity_type.nil?
  return false if @deleted.nil?
  return false if @mention_ids.nil?
  return false if @author_id.nil?
  return false if @member_mention_ids.nil?
  return false if @comments.nil?
  return false if @updated_at.nil?
  return false if @group_mention_ids.nil?
  return false if @external_id.nil?
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @text.nil?
  true
end