class DocuSign_eSign::Comment

Attributes

envelope_id[RW]

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

hmac[RW]
id[RW]
mentions[RW]
read[RW]
sent_by_email[RW]
sent_by_full_name[RW]
sent_by_image_id[RW]
sent_by_initials[RW]
sent_by_recipient_id[RW]
sent_by_user_id[RW]
signing_group_id[RW]

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).

signing_group_name[RW]

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

subject[RW]
tab_id[RW]

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

text[RW]
thread_id[RW]
thread_originator_id[RW]
time_stamp_formatted[RW]
timestamp[RW]
visible_to[RW]

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/docusign_esign/models/comment.rb, line 273
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/comment.rb, line 232
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/comment.rb, line 353
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_esign/models/comment.rb, line 347
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docusign_esign/models/comment.rb, line 239
def valid?
  true
end