class DocuSign_eSign::SenderEmailNotifications
Contains the settings for the email notifications that senders receive about the envelopes that they send.
Attributes
When set to *true*, the sender receives notification if the signer changes.
When set to *true*, the sender receives notification if the delivery of the envelope fails.
When set to *true*, the user receives notification that the envelope has been completed.
When set to *true*, the user receives notification if the offline signing failed.
When set to *true*, the sender receives notification that the recipient viewed the enveloper.
When set to *true*, the user receives notification if consent is withdrawn.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/sender_email_notifications.rb, line 54 def self.attribute_map { :'changed_signer' => :'changedSigner', :'clickwrap_responses_limit_notification_email' => :'clickwrapResponsesLimitNotificationEmail', :'comments_only_private_and_mention' => :'commentsOnlyPrivateAndMention', :'comments_receive_all' => :'commentsReceiveAll', :'delivery_failed' => :'deliveryFailed', :'envelope_complete' => :'envelopeComplete', :'offline_signing_failed' => :'offlineSigningFailed', :'powerform_responses_limit_notification_email' => :'powerformResponsesLimitNotificationEmail', :'purge_documents' => :'purgeDocuments', :'recipient_viewed' => :'recipientViewed', :'sender_envelope_declined' => :'senderEnvelopeDeclined', :'withdrawn_consent' => :'withdrawnConsent' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/sender_email_notifications.rb, line 91 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?(:'clickwrapResponsesLimitNotificationEmail') self.clickwrap_responses_limit_notification_email = attributes[:'clickwrapResponsesLimitNotificationEmail'] 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?(:'powerformResponsesLimitNotificationEmail') self.powerform_responses_limit_notification_email = attributes[:'powerformResponsesLimitNotificationEmail'] 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.withdrawn_consent = attributes[:'withdrawnConsent'] end end
Attribute type mapping.
# File lib/docusign_esign/models/sender_email_notifications.rb, line 72 def self.swagger_types { :'changed_signer' => :'String', :'clickwrap_responses_limit_notification_email' => :'String', :'comments_only_private_and_mention' => :'String', :'comments_receive_all' => :'String', :'delivery_failed' => :'String', :'envelope_complete' => :'String', :'offline_signing_failed' => :'String', :'powerform_responses_limit_notification_email' => :'String', :'purge_documents' => :'String', :'recipient_viewed' => :'String', :'sender_envelope_declined' => :'String', :'withdrawn_consent' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/sender_email_notifications.rb, line 161 def ==(o) return true if self.equal?(o) self.class == o.class && changed_signer == o.changed_signer && clickwrap_responses_limit_notification_email == o.clickwrap_responses_limit_notification_email && 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 && powerform_responses_limit_notification_email == o.powerform_responses_limit_notification_email && purge_documents == o.purge_documents && recipient_viewed == o.recipient_viewed && sender_envelope_declined == o.sender_envelope_declined && withdrawn_consent == o.withdrawn_consent end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/docusign_esign/models/sender_email_notifications.rb, line 214 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/docusign_esign/models/sender_email_notifications.rb, line 280 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/docusign_esign/models/sender_email_notifications.rb, line 193 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
@see the `==` method @param [Object] Object
to be compared
# File lib/docusign_esign/models/sender_email_notifications.rb, line 180 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/sender_email_notifications.rb, line 186 def hash [changed_signer, clickwrap_responses_limit_notification_email, comments_only_private_and_mention, comments_receive_all, delivery_failed, envelope_complete, offline_signing_failed, powerform_responses_limit_notification_email, purge_documents, recipient_viewed, sender_envelope_declined, withdrawn_consent].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docusign_esign/models/sender_email_notifications.rb, line 148 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/docusign_esign/models/sender_email_notifications.rb, line 266 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/docusign_esign/models/sender_email_notifications.rb, line 254 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/docusign_esign/models/sender_email_notifications.rb, line 155 def valid? true end