class DocuSign_eSign::AccountAddress
Contains information about an account address.
Attributes
First Line of the address. Maximum length: 100 characters.
Second Line of the address. Maximum length: 100 characters.
The city value of the address.
Specifies the country associated with the address.
The user's first name. Maximum Length: 50 characters.
The state or province associated with the address.
Contains an array of countries supported by the billing plan.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/account_address.rb, line 54 def self.attribute_map { :'address1' => :'address1', :'address2' => :'address2', :'city' => :'city', :'country' => :'country', :'email' => :'email', :'fax' => :'fax', :'first_name' => :'firstName', :'last_name' => :'lastName', :'phone' => :'phone', :'postal_code' => :'postalCode', :'state' => :'state', :'supported_countries' => :'supportedCountries' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/account_address.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?(:'address1') self.address1 = attributes[:'address1'] end if attributes.has_key?(:'address2') self.address2 = attributes[:'address2'] end if attributes.has_key?(:'city') self.city = attributes[:'city'] end if attributes.has_key?(:'country') self.country = attributes[:'country'] end if attributes.has_key?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'fax') self.fax = attributes[:'fax'] end if attributes.has_key?(:'firstName') self.first_name = attributes[:'firstName'] end if attributes.has_key?(:'lastName') self.last_name = attributes[:'lastName'] end if attributes.has_key?(:'phone') self.phone = attributes[:'phone'] end if attributes.has_key?(:'postalCode') self.postal_code = attributes[:'postalCode'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'supportedCountries') if (value = attributes[:'supportedCountries']).is_a?(Array) self.supported_countries = value end end end
Attribute type mapping.
# File lib/docusign_esign/models/account_address.rb, line 72 def self.swagger_types { :'address1' => :'String', :'address2' => :'String', :'city' => :'String', :'country' => :'String', :'email' => :'String', :'fax' => :'String', :'first_name' => :'String', :'last_name' => :'String', :'phone' => :'String', :'postal_code' => :'String', :'state' => :'String', :'supported_countries' => :'Array<Country>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/docusign_esign/models/account_address.rb, line 163 def ==(o) return true if self.equal?(o) self.class == o.class && address1 == o.address1 && address2 == o.address2 && city == o.city && country == o.country && email == o.email && fax == o.fax && first_name == o.first_name && last_name == o.last_name && phone == o.phone && postal_code == o.postal_code && state == o.state && supported_countries == o.supported_countries 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/account_address.rb, line 216 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/account_address.rb, line 282 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/account_address.rb, line 195 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/account_address.rb, line 182 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/account_address.rb, line 188 def hash [address1, address2, city, country, email, fax, first_name, last_name, phone, postal_code, state, supported_countries].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/account_address.rb, line 150 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/account_address.rb, line 268 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/account_address.rb, line 256 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/account_address.rb, line 157 def valid? true end