class DocuSign_eSign::SignHashDocument
Attributes
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/sign_hash_document.rb, line 40 def self.attribute_map { :'data' => :'data', :'document_id' => :'documentId', :'format' => :'format', :'name' => :'name', :'remaining_signatures' => :'remainingSignatures', :'revisions' => :'revisions', :'signature_properties' => :'signatureProperties', :'signature_type' => :'signatureType' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/sign_hash_document.rb, line 69 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?(:'data') self.data = attributes[:'data'] end if attributes.has_key?(:'documentId') self.document_id = attributes[:'documentId'] end if attributes.has_key?(:'format') self.format = attributes[:'format'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'remainingSignatures') self.remaining_signatures = attributes[:'remainingSignatures'] end if attributes.has_key?(:'revisions') if (value = attributes[:'revisions']).is_a?(Array) self.revisions = value end end if attributes.has_key?(:'signatureProperties') self.signature_properties = attributes[:'signatureProperties'] end if attributes.has_key?(:'signatureType') self.signature_type = attributes[:'signatureType'] end end
Attribute type mapping.
# File lib/docusign_esign/models/sign_hash_document.rb, line 54 def self.swagger_types { :'data' => :'String', :'document_id' => :'String', :'format' => :'String', :'name' => :'String', :'remaining_signatures' => :'Integer', :'revisions' => :'Array<Revision>', :'signature_properties' => :'SignatureProperties', :'signature_type' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/sign_hash_document.rb, line 125 def ==(o) return true if self.equal?(o) self.class == o.class && data == o.data && document_id == o.document_id && format == o.format && name == o.name && remaining_signatures == o.remaining_signatures && revisions == o.revisions && signature_properties == o.signature_properties && signature_type == o.signature_type 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/sign_hash_document.rb, line 174 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/sign_hash_document.rb, line 240 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/sign_hash_document.rb, line 153 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/sign_hash_document.rb, line 140 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/sign_hash_document.rb, line 146 def hash [data, document_id, format, name, remaining_signatures, revisions, signature_properties, signature_type].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/sign_hash_document.rb, line 112 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/sign_hash_document.rb, line 226 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/sign_hash_document.rb, line 214 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/sign_hash_document.rb, line 119 def valid? true end