Class: DocuSign_eSign::Comment

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

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



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'envelopeId')
    self.envelope_id = attributes[:'envelopeId']
  end

  if attributes.has_key?(:'hmac')
    self.hmac = attributes[:'hmac']
  end

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

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

  if attributes.has_key?(:'read')
    self.read = attributes[:'read']
  end

  if attributes.has_key?(:'sentByEmail')
    self.sent_by_email = attributes[:'sentByEmail']
  end

  if attributes.has_key?(:'sentByFullName')
    self.sent_by_full_name = attributes[:'sentByFullName']
  end

  if attributes.has_key?(:'sentByImageId')
    self.sent_by_image_id = attributes[:'sentByImageId']
  end

  if attributes.has_key?(:'sentByInitials')
    self.sent_by_initials = attributes[:'sentByInitials']
  end

  if attributes.has_key?(:'sentByRecipientId')
    self.sent_by_recipient_id = attributes[:'sentByRecipientId']
  end

  if attributes.has_key?(:'sentByUserId')
    self.sent_by_user_id = attributes[:'sentByUserId']
  end

  if attributes.has_key?(:'signingGroupId')
    self.signing_group_id = attributes[:'signingGroupId']
  end

  if attributes.has_key?(:'signingGroupName')
    self.signing_group_name = attributes[:'signingGroupName']
  end

  if attributes.has_key?(:'subject')
    self.subject = attributes[:'subject']
  end

  if attributes.has_key?(:'tabId')
    self.tab_id = attributes[:'tabId']
  end

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

  if attributes.has_key?(:'threadId')
    self.thread_id = attributes[:'threadId']
  end

  if attributes.has_key?(:'threadOriginatorId')
    self.thread_originator_id = attributes[:'threadOriginatorId']
  end

  if attributes.has_key?(:'timestamp')
    self.timestamp = attributes[:'timestamp']
  end

  if attributes.has_key?(:'timeStampFormatted')
    self.time_stamp_formatted = attributes[:'timeStampFormatted']
  end

  if attributes.has_key?(:'visibleTo')
    if (value = attributes[:'visibleTo']).is_a?(Array)
      self.visible_to = value
    end
  end
end

Instance Attribute Details

#envelope_id ⇒ Object

The envelope ID of the envelope status that failed to post.



17
18
19
 
# File 'lib/docusign_esign/models/comment.rb', line 17

def envelope_id
  @envelope_id
end

#hmac ⇒ Object

Returns the value of attribute hmac.



20
21
22
 
# File 'lib/docusign_esign/models/comment.rb', line 20

def hmac
  @hmac
end

#id ⇒ Object

Returns the value of attribute id.



23
24
25
 
# File 'lib/docusign_esign/models/comment.rb', line 23

def id
  @id
end

#mentions ⇒ Object

Returns the value of attribute mentions.



26
27
28
 
# File 'lib/docusign_esign/models/comment.rb', line 26

def mentions
  @mentions
end

#read ⇒ Object

Returns the value of attribute read.



29
30
31
 
# File 'lib/docusign_esign/models/comment.rb', line 29

def read
  @read
end

#sent_by_email ⇒ Object

Returns the value of attribute sent_by_email.



32
33
34
 
# File 'lib/docusign_esign/models/comment.rb', line 32

def sent_by_email
  @sent_by_email
end

#sent_by_full_name ⇒ Object

Returns the value of attribute sent_by_full_name.



35
36
37
 
# File 'lib/docusign_esign/models/comment.rb', line 35

def sent_by_full_name
  @sent_by_full_name
end

#sent_by_image_id ⇒ Object

Returns the value of attribute sent_by_image_id.



38
39
40
 
# File 'lib/docusign_esign/models/comment.rb', line 38

def sent_by_image_id
  @sent_by_image_id
end

#sent_by_initials ⇒ Object

Returns the value of attribute sent_by_initials.



41
42
43
 
# File 'lib/docusign_esign/models/comment.rb', line 41

def sent_by_initials
  @sent_by_initials
end

#sent_by_recipient_id ⇒ Object

Returns the value of attribute sent_by_recipient_id.



44
45
46
 
# File 'lib/docusign_esign/models/comment.rb', line 44

def sent_by_recipient_id
  @sent_by_recipient_id
end

#sent_by_user_id ⇒ Object

Returns the value of attribute sent_by_user_id.



47
48
49
 
# File 'lib/docusign_esign/models/comment.rb', line 47

def sent_by_user_id
  @sent_by_user_id
end

#signing_group_id ⇒ Object

When set to true and the feature is enabled in the sender’s account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).



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

def signing_group_id
  @signing_group_id
end

#signing_group_name ⇒ Object

The display name for the signing group. Maximum Length: 100 characters.



53
54
55
 
# File 'lib/docusign_esign/models/comment.rb', line 53

def signing_group_name
  @signing_group_name
end

#subject ⇒ Object

Returns the value of attribute subject.



56
57
58
 
# File 'lib/docusign_esign/models/comment.rb', line 56

def subject
  @subject
end

#tab_id ⇒ Object

The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].



59
60
61
 
# File 'lib/docusign_esign/models/comment.rb', line 59

def tab_id
  @tab_id
end

#text ⇒ Object

Returns the value of attribute text.



62
63
64
 
# File 'lib/docusign_esign/models/comment.rb', line 62

def text
  @text
end

#thread_id ⇒ Object

Returns the value of attribute thread_id.



65
66
67
 
# File 'lib/docusign_esign/models/comment.rb', line 65

def thread_id
  @thread_id
end

#thread_originator_id ⇒ Object

Returns the value of attribute thread_originator_id.



68
69
70
 
# File 'lib/docusign_esign/models/comment.rb', line 68

def thread_originator_id
  @thread_originator_id
end

#time_stamp_formatted ⇒ Object

Returns the value of attribute time_stamp_formatted.



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

def time_stamp_formatted
  @time_stamp_formatted
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.



71
72
73
 
# File 'lib/docusign_esign/models/comment.rb', line 71

def timestamp
  @timestamp
end

#visible_to ⇒ Object

Returns the value of attribute visible_to.



77
78
79
 
# File 'lib/docusign_esign/models/comment.rb', line 77

def visible_to
  @visible_to
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/docusign_esign/models/comment.rb', line 80

def self.attribute_map
  {
    :'envelope_id' => :'envelopeId',
    :'hmac' => :'hmac',
    :'id' => :'id',
    :'mentions' => :'mentions',
    :'read' => :'read',
    :'sent_by_email' => :'sentByEmail',
    :'sent_by_full_name' => :'sentByFullName',
    :'sent_by_image_id' => :'sentByImageId',
    :'sent_by_initials' => :'sentByInitials',
    :'sent_by_recipient_id' => :'sentByRecipientId',
    :'sent_by_user_id' => :'sentByUserId',
    :'signing_group_id' => :'signingGroupId',
    :'signing_group_name' => :'signingGroupName',
    :'subject' => :'subject',
    :'tab_id' => :'tabId',
    :'text' => :'text',
    :'thread_id' => :'threadId',
    :'thread_originator_id' => :'threadOriginatorId',
    :'timestamp' => :'timestamp',
    :'time_stamp_formatted' => :'timeStampFormatted',
    :'visible_to' => :'visibleTo'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'envelope_id' => :'String',
    :'hmac' => :'String',
    :'id' => :'String',
    :'mentions' => :'Array<String>',
    :'read' => :'BOOLEAN',
    :'sent_by_email' => :'String',
    :'sent_by_full_name' => :'String',
    :'sent_by_image_id' => :'String',
    :'sent_by_initials' => :'String',
    :'sent_by_recipient_id' => :'String',
    :'sent_by_user_id' => :'String',
    :'signing_group_id' => :'String',
    :'signing_group_name' => :'String',
    :'subject' => :'String',
    :'tab_id' => :'String',
    :'text' => :'String',
    :'thread_id' => :'String',
    :'thread_originator_id' => :'String',
    :'timestamp' => :'String',
    :'time_stamp_formatted' => :'String',
    :'visible_to' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/docusign_esign/models/comment.rb', line 245

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      envelope_id == o.envelope_id &&
      hmac == o.hmac &&
      id == o.id &&
      mentions == o.mentions &&
      read == o.read &&
      sent_by_email == o.sent_by_email &&
      sent_by_full_name == o.sent_by_full_name &&
      sent_by_image_id == o.sent_by_image_id &&
      sent_by_initials == o.sent_by_initials &&
      sent_by_recipient_id == o.sent_by_recipient_id &&
      sent_by_user_id == o.sent_by_user_id &&
      signing_group_id == o.signing_group_id &&
      signing_group_name == o.signing_group_name &&
      subject == o.subject &&
      tab_id == o.tab_id &&
      text == o.text &&
      thread_id == o.thread_id &&
      thread_originator_id == o.thread_originator_id &&
      timestamp == o.timestamp &&
      time_stamp_formatted == o.time_stamp_formatted &&
      visible_to == o.visible_to
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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/docusign_esign/models/comment.rb', line 307

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
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/docusign_esign/models/comment.rb', line 373

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/docusign_esign/models/comment.rb', line 286

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


273
274
275
 
# File 'lib/docusign_esign/models/comment.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



279
280
281
 
# File 'lib/docusign_esign/models/comment.rb', line 279

def hash
  [envelope_id, hmac, id, mentions, read, sent_by_email, sent_by_full_name, sent_by_image_id, sent_by_initials, sent_by_recipient_id, sent_by_user_id, signing_group_id, signing_group_name, subject, tab_id, text, thread_id, thread_originator_id, timestamp, time_stamp_formatted, visible_to].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



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

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



353
354
355
 
# File 'lib/docusign_esign/models/comment.rb', line 353

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



359
360
361
362
363
364
365
366
367
 
# File 'lib/docusign_esign/models/comment.rb', line 359

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



347
348
349
 
# File 'lib/docusign_esign/models/comment.rb', line 347

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



239
240
241
 
# File 'lib/docusign_esign/models/comment.rb', line 239

def valid?
  true
end