class SwaggerClient::Location
Attributes
A list of URLs of any images associated with this location.
The first line of the location’s street address.
A second address line for the location’s street address, if needed.
A list of strings representing amenities available at the location.
The average rating for the location, out of five stars.
The business description for the location, as configured by the business owner.
The location’s city.
A description of the location.
When `true`, indicates that classes are held at this location.<br /> When `false`, Indicates that classes are not held at this location.
The ID assigned to this location.
The location’s latitude.
The location’s longitude.
The name of this location.
The location’s phone number.
The location’s phone extension.
The location’s postal code.
The ID number assigned to this location.
The location’s state or province code.
A decimal representation of the location’s first tax rate. Tax properties are provided to apply all taxes to the purchase price that the purchase is subject to. Use as many tax properties as needed to represent all the taxes that apply in the location. Enter a decimal number that represents the appropriate tax rate. For example, for an 8% sales tax, enter 0.08.
A decimal representation of the location’s second tax rate. See the example in the description of Tax1.
A decimal representation of the location’s third tax rate. See the example in the description of Tax1.
A decimal representation of the location’s fourth tax rate. See the example in the description of Tax1.
A decimal representation of the location’s fifth tax rate. See the example in the description of Tax1.
The number of distinct introductory pricing options available for purchase at this location.
The number of reviews that clients have left for this location.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/swagger_client/models/location.rb, line 93 def self.attribute_map { :'additional_image_ur_ls' => :'AdditionalImageURLs', :'address' => :'Address', :'address2' => :'Address2', :'amenities' => :'Amenities', :'business_description' => :'BusinessDescription', :'city' => :'City', :'description' => :'Description', :'has_classes' => :'HasClasses', :'id' => :'Id', :'latitude' => :'Latitude', :'longitude' => :'Longitude', :'name' => :'Name', :'phone' => :'Phone', :'phone_extension' => :'PhoneExtension', :'postal_code' => :'PostalCode', :'site_id' => :'SiteID', :'state_prov_code' => :'StateProvCode', :'tax1' => :'Tax1', :'tax2' => :'Tax2', :'tax3' => :'Tax3', :'tax4' => :'Tax4', :'tax5' => :'Tax5', :'total_number_of_ratings' => :'TotalNumberOfRatings', :'average_rating' => :'AverageRating', :'total_number_of_deals' => :'TotalNumberOfDeals' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/swagger_client/models/location.rb, line 156 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?(:'AdditionalImageURLs') if (value = attributes[:'AdditionalImageURLs']).is_a?(Array) self.additional_image_ur_ls = value end end if attributes.has_key?(:'Address') self.address = attributes[:'Address'] end if attributes.has_key?(:'Address2') self.address2 = attributes[:'Address2'] end if attributes.has_key?(:'Amenities') if (value = attributes[:'Amenities']).is_a?(Array) self.amenities = value end end if attributes.has_key?(:'BusinessDescription') self.business_description = attributes[:'BusinessDescription'] end if attributes.has_key?(:'City') self.city = attributes[:'City'] end if attributes.has_key?(:'Description') self.description = attributes[:'Description'] end if attributes.has_key?(:'HasClasses') self.has_classes = attributes[:'HasClasses'] end if attributes.has_key?(:'Id') self.id = attributes[:'Id'] end if attributes.has_key?(:'Latitude') self.latitude = attributes[:'Latitude'] end if attributes.has_key?(:'Longitude') self.longitude = attributes[:'Longitude'] end if attributes.has_key?(:'Name') self.name = attributes[:'Name'] end if attributes.has_key?(:'Phone') self.phone = attributes[:'Phone'] end if attributes.has_key?(:'PhoneExtension') self.phone_extension = attributes[:'PhoneExtension'] end if attributes.has_key?(:'PostalCode') self.postal_code = attributes[:'PostalCode'] end if attributes.has_key?(:'SiteID') self.site_id = attributes[:'SiteID'] end if attributes.has_key?(:'StateProvCode') self.state_prov_code = attributes[:'StateProvCode'] end if attributes.has_key?(:'Tax1') self.tax1 = attributes[:'Tax1'] end if attributes.has_key?(:'Tax2') self.tax2 = attributes[:'Tax2'] end if attributes.has_key?(:'Tax3') self.tax3 = attributes[:'Tax3'] end if attributes.has_key?(:'Tax4') self.tax4 = attributes[:'Tax4'] end if attributes.has_key?(:'Tax5') self.tax5 = attributes[:'Tax5'] end if attributes.has_key?(:'TotalNumberOfRatings') self.total_number_of_ratings = attributes[:'TotalNumberOfRatings'] end if attributes.has_key?(:'AverageRating') self.average_rating = attributes[:'AverageRating'] end if attributes.has_key?(:'TotalNumberOfDeals') self.total_number_of_deals = attributes[:'TotalNumberOfDeals'] end end
Attribute type mapping.
# File lib/swagger_client/models/location.rb, line 124 def self.swagger_types { :'additional_image_ur_ls' => :'Array<String>', :'address' => :'String', :'address2' => :'String', :'amenities' => :'Array<Amenity>', :'business_description' => :'String', :'city' => :'String', :'description' => :'String', :'has_classes' => :'BOOLEAN', :'id' => :'Integer', :'latitude' => :'Float', :'longitude' => :'Float', :'name' => :'String', :'phone' => :'String', :'phone_extension' => :'String', :'postal_code' => :'String', :'site_id' => :'Integer', :'state_prov_code' => :'String', :'tax1' => :'Float', :'tax2' => :'Float', :'tax3' => :'Float', :'tax4' => :'Float', :'tax5' => :'Float', :'total_number_of_ratings' => :'Integer', :'average_rating' => :'Float', :'total_number_of_deals' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/swagger_client/models/location.rb, line 282 def ==(o) return true if self.equal?(o) self.class == o.class && additional_image_ur_ls == o.additional_image_ur_ls && address == o.address && address2 == o.address2 && amenities == o.amenities && business_description == o.business_description && city == o.city && description == o.description && has_classes == o.has_classes && id == o.id && latitude == o.latitude && longitude == o.longitude && name == o.name && phone == o.phone && phone_extension == o.phone_extension && postal_code == o.postal_code && site_id == o.site_id && state_prov_code == o.state_prov_code && tax1 == o.tax1 && tax2 == o.tax2 && tax3 == o.tax3 && tax4 == o.tax4 && tax5 == o.tax5 && total_number_of_ratings == o.total_number_of_ratings && average_rating == o.average_rating && total_number_of_deals == o.total_number_of_deals 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/swagger_client/models/location.rb, line 348 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 = SwaggerClient.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/swagger_client/models/location.rb, line 414 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/swagger_client/models/location.rb, line 327 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 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/swagger_client/models/location.rb, line 314 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/swagger_client/models/location.rb, line 320 def hash [additional_image_ur_ls, address, address2, amenities, business_description, city, description, has_classes, id, latitude, longitude, name, phone, phone_extension, postal_code, site_id, state_prov_code, tax1, tax2, tax3, tax4, tax5, total_number_of_ratings, average_rating, total_number_of_deals].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/swagger_client/models/location.rb, line 269 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/swagger_client/models/location.rb, line 400 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/swagger_client/models/location.rb, line 388 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/swagger_client/models/location.rb, line 276 def valid? true end