Class: DocuSign_eSign::EmailSettings

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

Overview

A complex element that allows the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. *IMPORTANT*: The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. EmailSettings consists of: * replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters. * replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters. * bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. DocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters. Example: if your account has BCC for Email Archive set up for the email address '[email protected]' and you send an envelope using the BCC Email Override to send a BCC email to '[email protected]', then a copy of the envelope is only sent to the '[email protected]' email address.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/docusign_esign/models/email_settings.rb', line 47

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?(:'bccEmailAddresses')
    if (value = attributes[:'bccEmailAddresses']).is_a?(Array)
      self.bcc_email_addresses = value
    end
  end

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

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

Instance Attribute Details

#bcc_email_addressesObject

A list of email addresses that receive a copy of all email communications for an envelope. You can use this for archiving purposes.


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

def bcc_email_addresses
  @bcc_email_addresses
end

#reply_email_address_overrideObject

Returns the value of attribute reply_email_address_override


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

def reply_email_address_override
  @reply_email_address_override
end

#reply_email_name_overrideObject

Returns the value of attribute reply_email_name_override


25
26
27
# File 'lib/docusign_esign/models/email_settings.rb', line 25

def reply_email_name_override
  @reply_email_name_override
end

Class Method Details

.attribute_mapObject

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


28
29
30
31
32
33
34
# File 'lib/docusign_esign/models/email_settings.rb', line 28

def self.attribute_map
  {
    :'bcc_email_addresses' => :'bccEmailAddresses',
    :'reply_email_address_override' => :'replyEmailAddressOverride',
    :'reply_email_name_override' => :'replyEmailNameOverride'
  }
end

.swagger_typesObject

Attribute type mapping.


37
38
39
40
41
42
43
# File 'lib/docusign_esign/models/email_settings.rb', line 37

def self.swagger_types
  {
    :'bcc_email_addresses' => :'Array<BccEmailAddress>',
    :'reply_email_address_override' => :'String',
    :'reply_email_name_override' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


83
84
85
86
87
88
89
# File 'lib/docusign_esign/models/email_settings.rb', line 83

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bcc_email_addresses == o.bcc_email_addresses &&
      reply_email_address_override == o.reply_email_address_override &&
      reply_email_name_override == o.reply_email_name_override
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


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

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


193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/docusign_esign/models/email_settings.rb', line 193

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


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/docusign_esign/models/email_settings.rb', line 106

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

93
94
95
# File 'lib/docusign_esign/models/email_settings.rb', line 93

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


99
100
101
# File 'lib/docusign_esign/models/email_settings.rb', line 99

def hash
  [bcc_email_addresses, reply_email_address_override, reply_email_name_override].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


173
174
175
# File 'lib/docusign_esign/models/email_settings.rb', line 173

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


179
180
181
182
183
184
185
186
187
# File 'lib/docusign_esign/models/email_settings.rb', line 179

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


167
168
169
# File 'lib/docusign_esign/models/email_settings.rb', line 167

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


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

def valid?
  true
end