class DocuSign_eSign::BulkSendEnvelopesInfo
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/bulk_send_envelopes_info.rb, line 56 def self.attribute_map { :'authoritative_copy' => :'authoritativeCopy', :'completed' => :'completed', :'correct' => :'correct', :'created' => :'created', :'declined' => :'declined', :'deleted' => :'deleted', :'delivered' => :'delivered', :'digital_signatures_pending' => :'digitalSignaturesPending', :'sent' => :'sent', :'signed' => :'signed', :'timed_out' => :'timedOut', :'transfer_completed' => :'transferCompleted', :'voided' => :'voided' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/bulk_send_envelopes_info.rb, line 95 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?(:'authoritativeCopy') self.authoritative_copy = attributes[:'authoritativeCopy'] end if attributes.has_key?(:'completed') self.completed = attributes[:'completed'] end if attributes.has_key?(:'correct') self.correct = attributes[:'correct'] end if attributes.has_key?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'declined') self.declined = attributes[:'declined'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] end if attributes.has_key?(:'delivered') self.delivered = attributes[:'delivered'] end if attributes.has_key?(:'digitalSignaturesPending') self.digital_signatures_pending = attributes[:'digitalSignaturesPending'] end if attributes.has_key?(:'sent') self.sent = attributes[:'sent'] end if attributes.has_key?(:'signed') self.signed = attributes[:'signed'] end if attributes.has_key?(:'timedOut') self.timed_out = attributes[:'timedOut'] end if attributes.has_key?(:'transferCompleted') self.transfer_completed = attributes[:'transferCompleted'] end if attributes.has_key?(:'voided') self.voided = attributes[:'voided'] end end
Attribute type mapping.
# File lib/docusign_esign/models/bulk_send_envelopes_info.rb, line 75 def self.swagger_types { :'authoritative_copy' => :'String', :'completed' => :'String', :'correct' => :'String', :'created' => :'String', :'declined' => :'String', :'deleted' => :'String', :'delivered' => :'String', :'digital_signatures_pending' => :'String', :'sent' => :'String', :'signed' => :'String', :'timed_out' => :'String', :'transfer_completed' => :'String', :'voided' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/bulk_send_envelopes_info.rb, line 169 def ==(o) return true if self.equal?(o) self.class == o.class && authoritative_copy == o.authoritative_copy && completed == o.completed && correct == o.correct && created == o.created && declined == o.declined && deleted == o.deleted && delivered == o.delivered && digital_signatures_pending == o.digital_signatures_pending && sent == o.sent && signed == o.signed && timed_out == o.timed_out && transfer_completed == o.transfer_completed && voided == o.voided 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/bulk_send_envelopes_info.rb, line 223 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/bulk_send_envelopes_info.rb, line 289 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/bulk_send_envelopes_info.rb, line 202 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/bulk_send_envelopes_info.rb, line 189 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/bulk_send_envelopes_info.rb, line 195 def hash [authoritative_copy, completed, correct, created, declined, deleted, delivered, digital_signatures_pending, sent, signed, timed_out, transfer_completed, voided].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/bulk_send_envelopes_info.rb, line 156 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/bulk_send_envelopes_info.rb, line 275 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/bulk_send_envelopes_info.rb, line 263 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/bulk_send_envelopes_info.rb, line 163 def valid? true end