ipgeolocation_sdk 1.0.0

data/lib/ipgeolocation_sdk/models/location.rb

@@ -0,0 +1,400 @@
+=begin
+#IPGeolocation.io - IP intelligence products
+
+#Ipgeolocation provides a set of APIs to make ip based decisions.
+
+The version of the OpenAPI document: 2.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module IpgeolocationSdk
+  class Location
+    attr_accessor :continent_code
+
+    attr_accessor :continent_name
+
+    attr_accessor :country_code2
+
+    attr_accessor :country_code3
+
+    attr_accessor :country_name
+
+    attr_accessor :country_name_official
+
+    attr_accessor :country_capital
+
+    attr_accessor :state_prov
+
+    attr_accessor :state_code
+
+    attr_accessor :district
+
+    attr_accessor :city
+
+    attr_accessor :zipcode
+
+    attr_accessor :latitude
+
+    attr_accessor :longitude
+
+    attr_accessor :is_eu
+
+    attr_accessor :country_flag
+
+    attr_accessor :geoname_id
+
+    attr_accessor :country_emoji
+
+    attr_accessor :accuracy_radius
+
+    attr_accessor :locality
+
+    attr_accessor :dma_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'continent_code' => :'continent_code',
+        :'continent_name' => :'continent_name',
+        :'country_code2' => :'country_code2',
+        :'country_code3' => :'country_code3',
+        :'country_name' => :'country_name',
+        :'country_name_official' => :'country_name_official',
+        :'country_capital' => :'country_capital',
+        :'state_prov' => :'state_prov',
+        :'state_code' => :'state_code',
+        :'district' => :'district',
+        :'city' => :'city',
+        :'zipcode' => :'zipcode',
+        :'latitude' => :'latitude',
+        :'longitude' => :'longitude',
+        :'is_eu' => :'is_eu',
+        :'country_flag' => :'country_flag',
+        :'geoname_id' => :'geoname_id',
+        :'country_emoji' => :'country_emoji',
+        :'accuracy_radius' => :'accuracy_radius',
+        :'locality' => :'locality',
+        :'dma_code' => :'dma_code'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'continent_code' => :'String',
+        :'continent_name' => :'String',
+        :'country_code2' => :'String',
+        :'country_code3' => :'String',
+        :'country_name' => :'String',
+        :'country_name_official' => :'String',
+        :'country_capital' => :'String',
+        :'state_prov' => :'String',
+        :'state_code' => :'String',
+        :'district' => :'String',
+        :'city' => :'String',
+        :'zipcode' => :'String',
+        :'latitude' => :'String',
+        :'longitude' => :'String',
+        :'is_eu' => :'Boolean',
+        :'country_flag' => :'String',
+        :'geoname_id' => :'String',
+        :'country_emoji' => :'String',
+        :'accuracy_radius' => :'String',
+        :'locality' => :'String',
+        :'dma_code' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `IpgeolocationSdk::Location` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `IpgeolocationSdk::Location`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'continent_code')
+        self.continent_code = attributes[:'continent_code']
+      end
+
+      if attributes.key?(:'continent_name')
+        self.continent_name = attributes[:'continent_name']
+      end
+
+      if attributes.key?(:'country_code2')
+        self.country_code2 = attributes[:'country_code2']
+      end
+
+      if attributes.key?(:'country_code3')
+        self.country_code3 = attributes[:'country_code3']
+      end
+
+      if attributes.key?(:'country_name')
+        self.country_name = attributes[:'country_name']
+      end
+
+      if attributes.key?(:'country_name_official')
+        self.country_name_official = attributes[:'country_name_official']
+      end
+
+      if attributes.key?(:'country_capital')
+        self.country_capital = attributes[:'country_capital']
+      end
+
+      if attributes.key?(:'state_prov')
+        self.state_prov = attributes[:'state_prov']
+      end
+
+      if attributes.key?(:'state_code')
+        self.state_code = attributes[:'state_code']
+      end
+
+      if attributes.key?(:'district')
+        self.district = attributes[:'district']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'zipcode')
+        self.zipcode = attributes[:'zipcode']
+      end
+
+      if attributes.key?(:'latitude')
+        self.latitude = attributes[:'latitude']
+      end
+
+      if attributes.key?(:'longitude')
+        self.longitude = attributes[:'longitude']
+      end
+
+      if attributes.key?(:'is_eu')
+        self.is_eu = attributes[:'is_eu']
+      end
+
+      if attributes.key?(:'country_flag')
+        self.country_flag = attributes[:'country_flag']
+      end
+
+      if attributes.key?(:'geoname_id')
+        self.geoname_id = attributes[:'geoname_id']
+      end
+
+      if attributes.key?(:'country_emoji')
+        self.country_emoji = attributes[:'country_emoji']
+      end
+
+      if attributes.key?(:'accuracy_radius')
+        self.accuracy_radius = attributes[:'accuracy_radius']
+      end
+
+      if attributes.key?(:'locality')
+        self.locality = attributes[:'locality']
+      end
+
+      if attributes.key?(:'dma_code')
+        self.dma_code = attributes[:'dma_code']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          continent_code == o.continent_code &&
+          continent_name == o.continent_name &&
+          country_code2 == o.country_code2 &&
+          country_code3 == o.country_code3 &&
+          country_name == o.country_name &&
+          country_name_official == o.country_name_official &&
+          country_capital == o.country_capital &&
+          state_prov == o.state_prov &&
+          state_code == o.state_code &&
+          district == o.district &&
+          city == o.city &&
+          zipcode == o.zipcode &&
+          latitude == o.latitude &&
+          longitude == o.longitude &&
+          is_eu == o.is_eu &&
+          country_flag == o.country_flag &&
+          geoname_id == o.geoname_id &&
+          country_emoji == o.country_emoji &&
+          accuracy_radius == o.accuracy_radius &&
+          locality == o.locality &&
+          dma_code == o.dma_code
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [continent_code, continent_name, country_code2, country_code3, country_name, country_name_official, country_capital, state_prov, state_code, district, city, zipcode, latitude, longitude, is_eu, country_flag, geoname_id, country_emoji, accuracy_radius, locality, dma_code].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = IpgeolocationSdk.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    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
+    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
+
+  end
+
+end