Class: DocuSign_eSign::RecipientEmailNotification

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecipientEmailNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# 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

Instance Attribute Details

#email_body ⇒ Object

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



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

def email_body
  @email_body
end

#email_body_metadata ⇒ Object

Returns the value of attribute email_body_metadata.



19
20
21
 
# File 'lib/docusign_esign/models/recipient_email_notification.rb', line 19

def email_body_metadata
  @email_body_metadata
end

#email_subject ⇒ Object

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.



22
23
24
 
# File 'lib/docusign_esign/models/recipient_email_notification.rb', line 22

def email_subject
  @email_subject
end

#email_subject_metadata ⇒ Object

Returns the value of attribute email_subject_metadata.



24
25
26
 
# File 'lib/docusign_esign/models/recipient_email_notification.rb', line 24

def email_subject_metadata
  @email_subject_metadata
end

#supported_language ⇒ Object

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



27
28
29
 
# File 'lib/docusign_esign/models/recipient_email_notification.rb', line 27

def supported_language
  @supported_language
end

#supported_language_metadata ⇒ Object

Returns the value of attribute supported_language_metadata.



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

def supported_language_metadata
  @supported_language_metadata
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



103
104
105
106
107
108
109
110
111
112
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# 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) ⇒ 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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


116
117
118
 
# File 'lib/docusign_esign/models/recipient_email_notification.rb', line 116

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



122
123
124
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



90
91
92
93
 
# File 'lib/docusign_esign/models/recipient_email_notification.rb', line 90

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



196
197
198
 
# File 'lib/docusign_esign/models/recipient_email_notification.rb', line 196

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



202
203
204
205
206
207
208
209
210
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



190
191
192
 
# File 'lib/docusign_esign/models/recipient_email_notification.rb', line 190

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



97
98
99
 
# File 'lib/docusign_esign/models/recipient_email_notification.rb', line 97

def valid?
  true
end