Class: DocuSign_eSign::SenderEmailNotifications
- Inherits:
-
Object
- Object
- DocuSign_eSign::SenderEmailNotifications
- Defined in:
- lib/docusign_esign/models/sender_email_notifications.rb
Instance Attribute Summary collapse
-
#changed_signer ⇒ Object
When set to true, the sender receives notification if the signer changes.
-
#comments_only_private_and_mention ⇒ Object
Returns the value of attribute comments_only_private_and_mention.
-
#comments_receive_all ⇒ Object
Returns the value of attribute comments_receive_all.
-
#delivery_failed ⇒ Object
When set to true, the sender receives notification if the delivery of the envelope fails.
-
#envelope_complete ⇒ Object
When set to true, the user receives notification that the envelope has been completed.
-
#offline_signing_failed ⇒ Object
When set to true, the user receives notification if the offline signing failed.
-
#purge_documents ⇒ Object
Returns the value of attribute purge_documents.
-
#recipient_viewed ⇒ Object
When set to true, the sender receives notification that the recipient viewed the enveloper.
-
#sender_envelope_declined ⇒ Object
Returns the value of attribute sender_envelope_declined.
-
#withdrawn_consent ⇒ Object
When set to true, the user receives notification if consent is withdrawn.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SenderEmailNotifications
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ SenderEmailNotifications
Initializes the object
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 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 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 82 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?(:'changedSigner') self.changed_signer = attributes[:'changedSigner'] 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?(:'deliveryFailed') self.delivery_failed = attributes[:'deliveryFailed'] end if attributes.has_key?(:'envelopeComplete') self.envelope_complete = attributes[:'envelopeComplete'] 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?(:'recipientViewed') self.recipient_viewed = attributes[:'recipientViewed'] end if attributes.has_key?(:'senderEnvelopeDeclined') self.sender_envelope_declined = attributes[:'senderEnvelopeDeclined'] end if attributes.has_key?(:'withdrawnConsent') self. = attributes[:'withdrawnConsent'] end end |
Instance Attribute Details
#changed_signer ⇒ Object
When set to true, the sender receives notification if the signer changes.
18 19 20 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 18 def changed_signer @changed_signer end |
#comments_only_private_and_mention ⇒ Object
Returns the value of attribute comments_only_private_and_mention.
21 22 23 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 21 def comments_only_private_and_mention @comments_only_private_and_mention end |
#comments_receive_all ⇒ Object
Returns the value of attribute comments_receive_all.
24 25 26 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 24 def comments_receive_all @comments_receive_all end |
#delivery_failed ⇒ Object
When set to true, the sender receives notification if the delivery of the envelope fails.
27 28 29 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 27 def delivery_failed @delivery_failed end |
#envelope_complete ⇒ Object
When set to true, the user receives notification that the envelope has been completed.
30 31 32 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 30 def envelope_complete @envelope_complete end |
#offline_signing_failed ⇒ Object
When set to true, the user receives notification if the offline signing failed.
33 34 35 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 33 def offline_signing_failed @offline_signing_failed end |
#purge_documents ⇒ Object
Returns the value of attribute purge_documents.
36 37 38 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 36 def purge_documents @purge_documents end |
#recipient_viewed ⇒ Object
When set to true, the sender receives notification that the recipient viewed the enveloper.
39 40 41 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 39 def recipient_viewed @recipient_viewed end |
#sender_envelope_declined ⇒ Object
Returns the value of attribute sender_envelope_declined.
42 43 44 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 42 def sender_envelope_declined @sender_envelope_declined end |
#withdrawn_consent ⇒ Object
When set to true, the user receives notification if consent is withdrawn.
45 46 47 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 45 def @withdrawn_consent end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 49 def self.attribute_map { :'changed_signer' => :'changedSigner', :'comments_only_private_and_mention' => :'commentsOnlyPrivateAndMention', :'comments_receive_all' => :'commentsReceiveAll', :'delivery_failed' => :'deliveryFailed', :'envelope_complete' => :'envelopeComplete', :'offline_signing_failed' => :'offlineSigningFailed', :'purge_documents' => :'purgeDocuments', :'recipient_viewed' => :'recipientViewed', :'sender_envelope_declined' => :'senderEnvelopeDeclined', :'withdrawn_consent' => :'withdrawnConsent' } end |
.swagger_types ⇒ Object
Attribute type mapping.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 65 def self.swagger_types { :'changed_signer' => :'String', :'comments_only_private_and_mention' => :'String', :'comments_receive_all' => :'String', :'delivery_failed' => :'String', :'envelope_complete' => :'String', :'offline_signing_failed' => :'String', :'purge_documents' => :'String', :'recipient_viewed' => :'String', :'sender_envelope_declined' => :'String', :'withdrawn_consent' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
145 146 147 148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 145 def ==(o) return true if self.equal?(o) self.class == o.class && changed_signer == o.changed_signer && comments_only_private_and_mention == o.comments_only_private_and_mention && comments_receive_all == o.comments_receive_all && delivery_failed == o.delivery_failed && envelope_complete == o.envelope_complete && offline_signing_failed == o.offline_signing_failed && purge_documents == o.purge_documents && recipient_viewed == o.recipient_viewed && sender_envelope_declined == o.sender_envelope_declined && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 196 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
262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 262 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
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 175 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
162 163 164 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 162 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
168 169 170 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 168 def hash [changed_signer, comments_only_private_and_mention, comments_receive_all, delivery_failed, envelope_complete, offline_signing_failed, purge_documents, recipient_viewed, sender_envelope_declined, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
132 133 134 135 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 132 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)
242 243 244 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 242 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
248 249 250 251 252 253 254 255 256 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 248 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
236 237 238 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 236 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
139 140 141 |
# File 'lib/docusign_esign/models/sender_email_notifications.rb', line 139 def valid? return true end |