class DocuSign_eSign::RecipientEmailNotification

Attributes

email_body[RW]

Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters.

email_body_metadata[RW]

email_subject[RW]

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

email_subject_metadata[RW]

supported_language[RW]

A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi).

supported_language_metadata[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/recipient_email_notification.rb, line 32
def self.attribute_map
  {
    :'email_body' => :'emailBody',
    :'email_body_metadata' => :'emailBodyMetadata',
    :'email_subject' => :'emailSubject',
    :'email_subject_metadata' => :'emailSubjectMetadata',
    :'supported_language' => :'supportedLanguage',
    :'supported_language_metadata' => :'supportedLanguageMetadata'
  }
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/recipient_email_notification.rb, line 57
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?(:'emailBody')
    self.email_body = attributes[:'emailBody']
  end

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

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

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

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

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

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/recipient_email_notification.rb, line 44
def self.swagger_types
  {
    :'email_body' => :'String',
    :'email_body_metadata' => :'PropertyMetadata',
    :'email_subject' => :'String',
    :'email_subject_metadata' => :'PropertyMetadata',
    :'supported_language' => :'String',
    :'supported_language_metadata' => :'PropertyMetadata'
  }
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/recipient_email_notification.rb, line 103
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email_body == o.email_body &&
      email_body_metadata == o.email_body_metadata &&
      email_subject == o.email_subject &&
      email_subject_metadata == o.email_subject_metadata &&
      supported_language == o.supported_language &&
      supported_language_metadata == o.supported_language_metadata
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/recipient_email_notification.rb, line 150
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/recipient_email_notification.rb, line 216
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/recipient_email_notification.rb, line 129
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/recipient_email_notification.rb, line 116
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/recipient_email_notification.rb, line 122
def hash
  [email_body, email_body_metadata, email_subject, email_subject_metadata, supported_language, supported_language_metadata].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/recipient_email_notification.rb, line 90
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/recipient_email_notification.rb, line 196
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/recipient_email_notification.rb, line 202
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/recipient_email_notification.rb, line 190
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/recipient_email_notification.rb, line 97
def valid?
  true
end