class DocuSign_eSign::Contact
Attributes
Array or errors.
The display name for the signing group. Maximum Length: 100 characters.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/contact.rb, line 62 def self.attribute_map { :'cloud_provider' => :'cloudProvider', :'cloud_provider_container_id' => :'cloudProviderContainerId', :'contact_id' => :'contactId', :'contact_phone_numbers' => :'contactPhoneNumbers', :'contact_uri' => :'contactUri', :'emails' => :'emails', :'error_details' => :'errorDetails', :'is_owner' => :'isOwner', :'name' => :'name', :'notary_contact_details' => :'notaryContactDetails', :'organization' => :'organization', :'room_contact_type' => :'roomContactType', :'shared' => :'shared', :'signing_group' => :'signingGroup', :'signing_group_name' => :'signingGroupName' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/contact.rb, line 105 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?(:'cloudProvider') self.cloud_provider = attributes[:'cloudProvider'] end if attributes.has_key?(:'cloudProviderContainerId') self.cloud_provider_container_id = attributes[:'cloudProviderContainerId'] end if attributes.has_key?(:'contactId') self.contact_id = attributes[:'contactId'] end if attributes.has_key?(:'contactPhoneNumbers') if (value = attributes[:'contactPhoneNumbers']).is_a?(Array) self.contact_phone_numbers = value end end if attributes.has_key?(:'contactUri') self.contact_uri = attributes[:'contactUri'] end if attributes.has_key?(:'emails') if (value = attributes[:'emails']).is_a?(Array) self.emails = value end end if attributes.has_key?(:'errorDetails') self.error_details = attributes[:'errorDetails'] end if attributes.has_key?(:'isOwner') self.is_owner = attributes[:'isOwner'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'notaryContactDetails') self.notary_contact_details = attributes[:'notaryContactDetails'] end if attributes.has_key?(:'organization') self.organization = attributes[:'organization'] end if attributes.has_key?(:'roomContactType') self.room_contact_type = attributes[:'roomContactType'] end if attributes.has_key?(:'shared') self.shared = attributes[:'shared'] end if attributes.has_key?(:'signingGroup') self.signing_group = attributes[:'signingGroup'] end if attributes.has_key?(:'signingGroupName') self.signing_group_name = attributes[:'signingGroupName'] end end
Attribute type mapping.
# File lib/docusign_esign/models/contact.rb, line 83 def self.swagger_types { :'cloud_provider' => :'String', :'cloud_provider_container_id' => :'String', :'contact_id' => :'String', :'contact_phone_numbers' => :'Array<ContactPhoneNumber>', :'contact_uri' => :'String', :'emails' => :'Array<String>', :'error_details' => :'ErrorDetails', :'is_owner' => :'BOOLEAN', :'name' => :'String', :'notary_contact_details' => :'NotaryContactDetails', :'organization' => :'String', :'room_contact_type' => :'String', :'shared' => :'String', :'signing_group' => :'String', :'signing_group_name' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/contact.rb, line 191 def ==(o) return true if self.equal?(o) self.class == o.class && cloud_provider == o.cloud_provider && cloud_provider_container_id == o.cloud_provider_container_id && contact_id == o.contact_id && contact_phone_numbers == o.contact_phone_numbers && contact_uri == o.contact_uri && emails == o.emails && error_details == o.error_details && is_owner == o.is_owner && name == o.name && notary_contact_details == o.notary_contact_details && organization == o.organization && room_contact_type == o.room_contact_type && shared == o.shared && signing_group == o.signing_group && signing_group_name == o.signing_group_name 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/contact.rb, line 247 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/contact.rb, line 313 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/contact.rb, line 226 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/contact.rb, line 213 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/contact.rb, line 219 def hash [cloud_provider, cloud_provider_container_id, contact_id, contact_phone_numbers, contact_uri, emails, error_details, is_owner, name, notary_contact_details, organization, room_contact_type, shared, signing_group, signing_group_name].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/contact.rb, line 178 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/contact.rb, line 299 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/contact.rb, line 287 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/contact.rb, line 185 def valid? true end