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



102
103
104
105
106
107
108
109
110
111
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
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 102

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?(:'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_notification ⇒ Object

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



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

def agent_notification
  @agent_notification
end

#carbon_copy_notification ⇒ Object

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



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

def carbon_copy_notification
  @carbon_copy_notification
end

#certified_delivery_notification ⇒ Object

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



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

def certified_delivery_notification
  @certified_delivery_notification
end

#document_markup_activation ⇒ Object

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



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

def document_markup_activation
  @document_markup_activation
end

#envelope_activation ⇒ Object

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



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

def envelope_activation
  @envelope_activation
end

#envelope_complete ⇒ Object

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



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

def envelope_complete
  @envelope_complete
end

#envelope_corrected ⇒ Object

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



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

def envelope_corrected
  @envelope_corrected
end

#envelope_declined ⇒ Object

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



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

def envelope_declined
  @envelope_declined
end

#envelope_voided ⇒ Object

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



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

def envelope_voided
  @envelope_voided
end

#fax_received ⇒ Object

Reserved:



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

def fax_received
  @fax_received
end

#offline_signing_failed ⇒ Object

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



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

def offline_signing_failed
  @offline_signing_failed
end

#purge_documents ⇒ Object

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



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

def purge_documents
  @purge_documents
end

#reassigned_signer ⇒ Object

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



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

def reassigned_signer
  @reassigned_signer
end

#when_signing_group_member ⇒ Object

Returns the value of attribute when_signing_group_member.



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

def when_signing_group_member
  @when_signing_group_member
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 61

def self.attribute_map
  {
    :'agent_notification' => :'agentNotification',
    :'carbon_copy_notification' => :'carbonCopyNotification',
    :'certified_delivery_notification' => :'certifiedDeliveryNotification',
    :'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_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 81

def self.swagger_types
  {
    :'agent_notification' => :'String',
    :'carbon_copy_notification' => :'String',
    :'certified_delivery_notification' => :'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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 181

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 &&
      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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 236

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 302

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 215

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


202
203
204
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 202

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



208
209
210
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 208

def hash
  [agent_notification, carbon_copy_notification, certified_delivery_notification, 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_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



168
169
170
171
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 168

def list_invalid_properties
  invalid_properties = Array.new
  return 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



282
283
284
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 282

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



288
289
290
291
292
293
294
295
296
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 288

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



276
277
278
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 276

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



175
176
177
 
# File 'lib/docusign_esign/models/signer_email_notifications.rb', line 175

def valid?
  return true
end