class DocuSign_eSign::EnvelopeUpdateSummary
Attributes
The envelope ID of the envelope status that failed to post.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/envelope_update_summary.rb, line 40 def self.attribute_map { :'bulk_envelope_status' => :'bulkEnvelopeStatus', :'envelope_id' => :'envelopeId', :'error_details' => :'errorDetails', :'list_custom_field_update_results' => :'listCustomFieldUpdateResults', :'lock_information' => :'lockInformation', :'purge_state' => :'purgeState', :'recipient_update_results' => :'recipientUpdateResults', :'tab_update_results' => :'tabUpdateResults', :'text_custom_field_update_results' => :'textCustomFieldUpdateResults' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/envelope_update_summary.rb, line 71 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?(:'bulkEnvelopeStatus') self.bulk_envelope_status = attributes[:'bulkEnvelopeStatus'] end if attributes.has_key?(:'envelopeId') self.envelope_id = attributes[:'envelopeId'] end if attributes.has_key?(:'errorDetails') self.error_details = attributes[:'errorDetails'] end if attributes.has_key?(:'listCustomFieldUpdateResults') if (value = attributes[:'listCustomFieldUpdateResults']).is_a?(Array) self.list_custom_field_update_results = value end end if attributes.has_key?(:'lockInformation') self.lock_information = attributes[:'lockInformation'] end if attributes.has_key?(:'purgeState') self.purge_state = attributes[:'purgeState'] end if attributes.has_key?(:'recipientUpdateResults') if (value = attributes[:'recipientUpdateResults']).is_a?(Array) self.recipient_update_results = value end end if attributes.has_key?(:'tabUpdateResults') self.tab_update_results = attributes[:'tabUpdateResults'] end if attributes.has_key?(:'textCustomFieldUpdateResults') if (value = attributes[:'textCustomFieldUpdateResults']).is_a?(Array) self.text_custom_field_update_results = value end end end
Attribute type mapping.
# File lib/docusign_esign/models/envelope_update_summary.rb, line 55 def self.swagger_types { :'bulk_envelope_status' => :'BulkEnvelopeStatus', :'envelope_id' => :'String', :'error_details' => :'ErrorDetails', :'list_custom_field_update_results' => :'Array<ListCustomField>', :'lock_information' => :'LockInformation', :'purge_state' => :'String', :'recipient_update_results' => :'Array<RecipientUpdateResponse>', :'tab_update_results' => :'Tabs', :'text_custom_field_update_results' => :'Array<TextCustomField>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/envelope_update_summary.rb, line 135 def ==(o) return true if self.equal?(o) self.class == o.class && bulk_envelope_status == o.bulk_envelope_status && envelope_id == o.envelope_id && error_details == o.error_details && list_custom_field_update_results == o.list_custom_field_update_results && lock_information == o.lock_information && purge_state == o.purge_state && recipient_update_results == o.recipient_update_results && tab_update_results == o.tab_update_results && text_custom_field_update_results == o.text_custom_field_update_results 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/envelope_update_summary.rb, line 185 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/envelope_update_summary.rb, line 251 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/envelope_update_summary.rb, line 164 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/envelope_update_summary.rb, line 151 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/envelope_update_summary.rb, line 157 def hash [bulk_envelope_status, envelope_id, error_details, list_custom_field_update_results, lock_information, purge_state, recipient_update_results, tab_update_results, text_custom_field_update_results].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/envelope_update_summary.rb, line 122 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/envelope_update_summary.rb, line 237 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/envelope_update_summary.rb, line 225 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/envelope_update_summary.rb, line 129 def valid? true end