Class: Shortcut::StoryComment

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

Overview

A Comment is any note added within the Comment field of a Story.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StoryComment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 110

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shortcut::StoryComment` 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::StoryComment`. 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?(:'story_id')
    self.story_id = attributes[:'story_id']
  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?(:'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?(:'position')
    self.position = attributes[:'position']
  end

  if attributes.key?(:'reactions')
    if (value = attributes[:'reactions']).is_a?(Array)
      self.reactions = value
    end
  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/story_comment.rb', line 18

def app_url
  @app_url
end

#author_id ⇒ Object

The unique ID of the Member who is the Comment’s author.



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

def author_id
  @author_id
end

#created_at ⇒ Object

The time/date when the Comment was created.



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

def created_at
  @created_at
end

#entity_type ⇒ Object

A string description of this resource.



21
22
23
 
# File 'lib/shortcut_client_ruby/models/story_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.



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

def external_id
  @external_id
end

#group_mention_ids ⇒ Object

The unique IDs of the Group who are mentioned in the Comment.



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

def group_mention_ids
  @group_mention_ids
end

#id ⇒ Object

The unique ID of the Comment.



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

def id
  @id
end

#member_mention_ids ⇒ Object

The unique IDs of the Member who are mentioned in the Comment.



33
34
35
 
# File 'lib/shortcut_client_ruby/models/story_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/story_comment.rb', line 27

def mention_ids
  @mention_ids
end

#position ⇒ Object

The Comments numerical position in the list from oldest to newest.



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

def position
  @position
end

#reactions ⇒ Object

A set of Reactions to this Comment.



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

def reactions
  @reactions
end

#story_id ⇒ Object

The ID of the Story on which the Comment appears.



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

def story_id
  @story_id
end

#text ⇒ Object

The text of the Comment.



57
58
59
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 57

def text
  @text
end

#updated_at ⇒ Object

The time/date when the Comment was updated.



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

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 60

def self.attribute_map
  {
    :'app_url' => :'app_url',
    :'entity_type' => :'entity_type',
    :'story_id' => :'story_id',
    :'mention_ids' => :'mention_ids',
    :'author_id' => :'author_id',
    :'member_mention_ids' => :'member_mention_ids',
    :'updated_at' => :'updated_at',
    :'group_mention_ids' => :'group_mention_ids',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'position' => :'position',
    :'reactions' => :'reactions',
    :'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



307
308
309
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 307

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
104
105
106
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 80

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 273

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app_url == o.app_url &&
      entity_type == o.entity_type &&
      story_id == o.story_id &&
      mention_ids == o.mention_ids &&
      author_id == o.author_id &&
      member_mention_ids == o.member_mention_ids &&
      updated_at == o.updated_at &&
      group_mention_ids == o.group_mention_ids &&
      external_id == o.external_id &&
      id == o.id &&
      position == o.position &&
      reactions == o.reactions &&
      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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 337

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



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 406

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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 314

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


294
295
296
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



300
301
302
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 300

def hash
  [app_url, entity_type, story_id, mention_ids, author_id, member_mention_ids, updated_at, group_mention_ids, external_id, id, position, reactions, 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



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 190

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 @story_id.nil?
    invalid_properties.push('invalid value for "story_id", story_id 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 @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 @position.nil?
    invalid_properties.push('invalid value for "position", position cannot be nil.')
  end

  if @reactions.nil?
    invalid_properties.push('invalid value for "reactions", reactions 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



382
383
384
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 382

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



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

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



376
377
378
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 376

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/shortcut_client_ruby/models/story_comment.rb', line 253

def valid?
  return false if @app_url.nil?
  return false if @entity_type.nil?
  return false if @story_id.nil?
  return false if @mention_ids.nil?
  return false if @author_id.nil?
  return false if @member_mention_ids.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 @position.nil?
  return false if @reactions.nil?
  return false if @created_at.nil?
  return false if @text.nil?
  true
end