Class: DocuSign_eSign::SignerEmailNotifications

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

Overview

An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignerEmailNotifications

Initializes the object

Parameters:

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

    Model attributes in the form of hash


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 112

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?(:'agentNotification')
    self.agent_notification = attributes[:'agentNotification']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#agent_notificationObject

When set to *true*, the user receives agent notification emails.


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

def agent_notification
  @agent_notification
end

#carbon_copy_notificationObject

When set to *true*, the user receives notifications of carbon copy deliveries.


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

def carbon_copy_notification
  @carbon_copy_notification
end

#certified_delivery_notificationObject

When set to *true*, the user receives notifications of certified deliveries.


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

def certified_delivery_notification
  @certified_delivery_notification
end

#comments_only_private_and_mentionObject

Returns the value of attribute comments_only_private_and_mention


28
29
30
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 28

def comments_only_private_and_mention
  @comments_only_private_and_mention
end

#comments_receive_allObject

Returns the value of attribute comments_receive_all


31
32
33
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 31

def comments_receive_all
  @comments_receive_all
end

#document_markup_activationObject

When set to *true*, the user receives notification that document markup has been activated.


34
35
36
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 34

def document_markup_activation
  @document_markup_activation
end

#envelope_activationObject

When set to *true*, the user receives notification that the envelope has been activated.


37
38
39
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 37

def envelope_activation
  @envelope_activation
end

#envelope_completeObject

When set to *true*, the user receives notification that the envelope has been completed.


40
41
42
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 40

def envelope_complete
  @envelope_complete
end

#envelope_correctedObject

When set to *true*, the user receives notification that the envelope has been corrected.


43
44
45
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 43

def envelope_corrected
  @envelope_corrected
end

#envelope_declinedObject

When set to *true*, the user receives notification that the envelope has been declined.


46
47
48
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 46

def envelope_declined
  @envelope_declined
end

#envelope_voidedObject

When set to *true*, the user receives notification that the envelope has been voided.


49
50
51
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 49

def envelope_voided
  @envelope_voided
end

#fax_receivedObject

Reserved:


52
53
54
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 52

def fax_received
  @fax_received
end

#offline_signing_failedObject

When set to *true*, the user receives notification if the offline signing failed.


55
56
57
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 55

def offline_signing_failed
  @offline_signing_failed
end

#purge_documentsObject

When set to *true*, the user receives notification of document purges.


58
59
60
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 58

def purge_documents
  @purge_documents
end

#reassigned_signerObject

When set to *true*, the user receives notification that the envelope has been reassigned.


61
62
63
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 61

def reassigned_signer
  @reassigned_signer
end

#when_signing_group_memberObject

Returns the value of attribute when_signing_group_member


64
65
66
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 64

def when_signing_group_member
  @when_signing_group_member
end

Class Method Details

.attribute_mapObject

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


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/signer_email_notifications.rb', line 67

def self.attribute_map
  {
    :'agent_notification' => :'agentNotification',
    :'carbon_copy_notification' => :'carbonCopyNotification',
    :'certified_delivery_notification' => :'certifiedDeliveryNotification',
    :'comments_only_private_and_mention' => :'commentsOnlyPrivateAndMention',
    :'comments_receive_all' => :'commentsReceiveAll',
    :'document_markup_activation' => :'documentMarkupActivation',
    :'envelope_activation' => :'envelopeActivation',
    :'envelope_complete' => :'envelopeComplete',
    :'envelope_corrected' => :'envelopeCorrected',
    :'envelope_declined' => :'envelopeDeclined',
    :'envelope_voided' => :'envelopeVoided',
    :'fax_received' => :'faxReceived',
    :'offline_signing_failed' => :'offlineSigningFailed',
    :'purge_documents' => :'purgeDocuments',
    :'reassigned_signer' => :'reassignedSigner',
    :'when_signing_group_member' => :'whenSigningGroupMember'
  }
end

.swagger_typesObject

Attribute type mapping.


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 89

def self.swagger_types
  {
    :'agent_notification' => :'String',
    :'carbon_copy_notification' => :'String',
    :'certified_delivery_notification' => :'String',
    :'comments_only_private_and_mention' => :'String',
    :'comments_receive_all' => :'String',
    :'document_markup_activation' => :'String',
    :'envelope_activation' => :'String',
    :'envelope_complete' => :'String',
    :'envelope_corrected' => :'String',
    :'envelope_declined' => :'String',
    :'envelope_voided' => :'String',
    :'fax_received' => :'String',
    :'offline_signing_failed' => :'String',
    :'purge_documents' => :'String',
    :'reassigned_signer' => :'String',
    :'when_signing_group_member' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      agent_notification == o.agent_notification &&
      carbon_copy_notification == o.carbon_copy_notification &&
      certified_delivery_notification == o.certified_delivery_notification &&
      comments_only_private_and_mention == o.comments_only_private_and_mention &&
      comments_receive_all == o.comments_receive_all &&
      document_markup_activation == o.document_markup_activation &&
      envelope_activation == o.envelope_activation &&
      envelope_complete == o.envelope_complete &&
      envelope_corrected == o.envelope_corrected &&
      envelope_declined == o.envelope_declined &&
      envelope_voided == o.envelope_voided &&
      fax_received == o.fax_received &&
      offline_signing_failed == o.offline_signing_failed &&
      purge_documents == o.purge_documents &&
      reassigned_signer == o.reassigned_signer &&
      when_signing_group_member == o.when_signing_group_member
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


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 255

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


321
322
323
324
325
326
327
328
329
330
331
332
333
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 321

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


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 234

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

221
222
223
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 221

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


227
228
229
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 227

def hash
  [agent_notification, carbon_copy_notification, certified_delivery_notification, comments_only_private_and_mention, comments_receive_all, document_markup_activation, envelope_activation, envelope_complete, envelope_corrected, envelope_declined, envelope_voided, fax_received, offline_signing_failed, purge_documents, reassigned_signer, when_signing_group_member].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


185
186
187
188
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 185

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


301
302
303
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 301

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


307
308
309
310
311
312
313
314
315
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 307

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


295
296
297
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 295

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


192
193
194
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 192

def valid?
  true
end