Class: MergeTicketingClient::Comment

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ticketing_client/models/comment.rb

Overview

# The Comment Object ### Description The ‘Comment` object is used to represent a comment on a ticket. ### Usage Example TODO

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Comment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 115

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

The comment’s text body.



31
32
33
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 31

def body
  @body
end

#contact ⇒ Object

The author of the Comment, if the author is a Contact.



28
29
30
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 28

def contact
  @contact
end

#field_mappings ⇒ Object

Returns the value of attribute field_mappings.



50
51
52
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 50

def field_mappings
  @field_mappings
end

#html_body ⇒ Object

The comment’s text body formatted as html.



34
35
36
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 34

def html_body
  @html_body
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 19

def id
  @id
end

#is_private ⇒ Object

Whether or not the comment is internal.



40
41
42
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 40

def is_private
  @is_private
end

#modified_at ⇒ Object

This is the datetime that this object was last updated by Merge



48
49
50
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 48

def modified_at
  @modified_at
end

#remote_created_at ⇒ Object

When the third party’s comment was created.



43
44
45
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 43

def remote_created_at
  @remote_created_at
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



52
53
54
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 52

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 22

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Object

Returns the value of attribute remote_was_deleted.



45
46
47
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 45

def remote_was_deleted
  @remote_was_deleted
end

#ticket ⇒ Object

The ticket associated with the comment.



37
38
39
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 37

def ticket
  @ticket
end

#user ⇒ Object

The author of the Comment, if the author is a User.



25
26
27
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 25

def user
  @user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 55

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'user' => :'user',
    :'contact' => :'contact',
    :'body' => :'body',
    :'html_body' => :'html_body',
    :'ticket' => :'ticket',
    :'is_private' => :'is_private',
    :'remote_created_at' => :'remote_created_at',
    :'remote_was_deleted' => :'remote_was_deleted',
    :'modified_at' => :'modified_at',
    :'field_mappings' => :'field_mappings',
    :'remote_data' => :'remote_data'
  }
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



233
234
235
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 233

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 98

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'user',
    :'contact',
    :'body',
    :'html_body',
    :'ticket',
    :'is_private',
    :'remote_created_at',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 79

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'user' => :'String',
    :'contact' => :'String',
    :'body' => :'String',
    :'html_body' => :'String',
    :'ticket' => :'String',
    :'is_private' => :'Boolean',
    :'remote_created_at' => :'Time',
    :'remote_was_deleted' => :'Boolean',
    :'modified_at' => :'Time',
    :'field_mappings' => :'Hash<String, Object>',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      user == o.user &&
      contact == o.contact &&
      body == o.body &&
      html_body == o.html_body &&
      ticket == o.ticket &&
      is_private == o.is_private &&
      remote_created_at == o.remote_created_at &&
      remote_was_deleted == o.remote_was_deleted &&
      modified_at == o.modified_at &&
      field_mappings == o.field_mappings &&
      remote_data == o.remote_data
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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 263

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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
    # models (e.g. Pet) or oneOf
    klass = MergeTicketingClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 334

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 240

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


220
221
222
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 226

def hash
  [id, remote_id, user, contact, body, html_body, ticket, is_private, remote_created_at, remote_was_deleted, modified_at, field_mappings, remote_data].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



187
188
189
190
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 187

def list_invalid_properties
  invalid_properties = Array.new
  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



310
311
312
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 310

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 316

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



304
305
306
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 304

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



194
195
196
 
# File 'lib/merge_ticketing_client/models/comment.rb', line 194

def valid?
  true
end