Class: Merge::Ticketing::Comment

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/ticketing/types/comment.rb

Overview

# The Comment Object

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, user: OMIT, contact: OMIT, body: OMIT, html_body: OMIT, ticket: OMIT, is_private: OMIT, remote_created_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Ticketing::Comment

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • user (Merge::Ticketing::CommentUser) (defaults to: OMIT) —

    The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of name]” to the comment.

  • contact (Merge::Ticketing::CommentContact) (defaults to: OMIT) —

    The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of name]” to the comment.

  • body (String) (defaults to: OMIT) —

    The comment’s text body.

  • html_body (String) (defaults to: OMIT) —

    The comment’s text body formatted as html.

  • ticket (Merge::Ticketing::CommentTicket) (defaults to: OMIT) —

    The ticket associated with the comment.

  • is_private (Boolean) (defaults to: OMIT) —

    Whether or not the comment is internal.

  • remote_created_at (DateTime) (defaults to: OMIT) —

    When the third party’s comment was created.

  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Ticketing::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 85

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, user: OMIT, contact: OMIT,
               body: OMIT, html_body: OMIT, ticket: OMIT, is_private: OMIT, remote_created_at: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @user = user if user != OMIT
  @contact = contact if contact != OMIT
  @body = body if body != OMIT
  @html_body = html_body if html_body != OMIT
  @ticket = ticket if ticket != OMIT
  @is_private = is_private if is_private != OMIT
  @remote_created_at = remote_created_at if remote_created_at != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "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,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



55
56
57
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 55

def additional_properties
  @additional_properties
end

#body ⇒ String (readonly)

Returns The comment’s text body.

Returns:

  • (String) —

    The comment’s text body.



36
37
38
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 36

def body
  @body
end

#contact ⇒ Merge::Ticketing::CommentContact (readonly)

Returns The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of name]” to the comment.

Returns:

  • (Merge::Ticketing::CommentContact) —

    The author of the Comment, if the author is a Contact.If the third party does not support specifying an author, we will append “[Posted on behalf of name]” to the comment.



34
35
36
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 34

def contact
  @contact
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



24
25
26
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 24

def created_at
  @created_at
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


51
52
53
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 51

def field_mappings
  @field_mappings
end

#html_body ⇒ String (readonly)

Returns The comment’s text body formatted as html.

Returns:

  • (String) —

    The comment’s text body formatted as html.



38
39
40
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 38

def html_body
  @html_body
end

#id ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 20

def id
  @id
end

#is_private ⇒ Boolean (readonly)

Returns Whether or not the comment is internal.

Returns:

  • (Boolean) —

    Whether or not the comment is internal.



42
43
44
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 42

def is_private
  @is_private
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



26
27
28
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 26

def modified_at
  @modified_at
end

#remote_created_at ⇒ DateTime (readonly)

Returns When the third party’s comment was created.

Returns:

  • (DateTime) —

    When the third party’s comment was created.



44
45
46
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 44

def remote_created_at
  @remote_created_at
end

#remote_data ⇒ Array<Merge::Ticketing::RemoteData> (readonly)

Returns:



53
54
55
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 53

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 22

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](docs.merge.dev/integrations/hris/supported-features/).



49
50
51
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 49

def remote_was_deleted
  @remote_was_deleted
end

#ticket ⇒ Merge::Ticketing::CommentTicket (readonly)

Returns The ticket associated with the comment.

Returns:



40
41
42
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 40

def ticket
  @ticket
end

#user ⇒ Merge::Ticketing::CommentUser (readonly)

Returns The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of name]” to the comment.

Returns:

  • (Merge::Ticketing::CommentUser) —

    The author of the Comment, if the author is a User. If the third party does not support specifying an author, we will append “[Posted on behalf of name]” to the comment.



30
31
32
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 30

def user
  @user
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Ticketing::Comment

Deserialize a JSON object to an instance of Comment

Parameters:

  • json_object (String)

Returns:



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
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 126

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  if parsed_json["user"].nil?
    user = nil
  else
    user = parsed_json["user"].to_json
    user = Merge::Ticketing::CommentUser.from_json(json_object: user)
  end
  if parsed_json["contact"].nil?
    contact = nil
  else
    contact = parsed_json["contact"].to_json
    contact = Merge::Ticketing::CommentContact.from_json(json_object: contact)
  end
  body = parsed_json["body"]
  html_body = parsed_json["html_body"]
  if parsed_json["ticket"].nil?
    ticket = nil
  else
    ticket = parsed_json["ticket"].to_json
    ticket = Merge::Ticketing::CommentTicket.from_json(json_object: ticket)
  end
  is_private = parsed_json["is_private"]
  remote_created_at = unless parsed_json["remote_created_at"].nil?
                        DateTime.parse(parsed_json["remote_created_at"])
                      end
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Ticketing::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    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,
    field_mappings: field_mappings,
    remote_data: remote_data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 195

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.user.nil? || Merge::Ticketing::CommentUser.validate_raw(obj: obj.user)
  obj.contact.nil? || Merge::Ticketing::CommentContact.validate_raw(obj: obj.contact)
  obj.body&.is_a?(String) != false || raise("Passed value for field obj.body is not the expected type, validation failed.")
  obj.html_body&.is_a?(String) != false || raise("Passed value for field obj.html_body is not the expected type, validation failed.")
  obj.ticket.nil? || Merge::Ticketing::CommentTicket.validate_raw(obj: obj.ticket)
  obj.is_private&.is_a?(Boolean) != false || raise("Passed value for field obj.is_private is not the expected type, validation failed.")
  obj.remote_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.remote_created_at is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of Comment to a JSON object

Returns:

  • (String) 


185
186
187
 
# File 'lib/merge_ruby_client/ticketing/types/comment.rb', line 185

def to_json(*_args)
  @_field_set&.to_json
end