pokeapi_client 2.0.0 → 2.2.0

data/lib/pokeapi_client/models/pokemon_encounter_version_detail_response.rb

@@ -0,0 +1,234 @@
+=begin
+#PokéAPI
+
+#All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API.  ## What is this?  This is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series.  We've covered everything from Pokémon to Berry Flavors.  ## Where do I start?  We have awesome [documentation](https://pokeapi.co/docs/v2) on how to use this API. It takes minutes to get started.  This API will always be publicly available and will never require any extensive setup process to consume.  Created by [**Paul Hallett**](https://github.com/phalt) and other [**PokéAPI contributors**](https://github.com/PokeAPI/pokeapi#contributing) around the world. Pokémon and Pokémon character names are trademarks of Nintendo.
+
+The version of the OpenAPI document: 2.10.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PokeApiClient
+  class PokemonEncounterVersionDetailResponse < ApiModelBase
+    # The game version this encounter happens in.
+    attr_accessor :version
+
+    # The total percentage of all encounter potential.
+    attr_accessor :max_chance
+
+    # A list of encounters and their specifics.
+    attr_accessor :encounter_details
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'version' => :'version',
+        :'max_chance' => :'max_chance',
+        :'encounter_details' => :'encounter_details'
+      }
+    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
+      {
+        :'version' => :'VersionSummary',
+        :'max_chance' => :'Integer',
+        :'encounter_details' => :'Array<PokemonEncounterDetailResponse>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    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 `PokeApiClient::PokemonEncounterVersionDetailResponse` 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 `PokeApiClient::PokemonEncounterVersionDetailResponse`. 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?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = nil
+      end
+
+      if attributes.key?(:'max_chance')
+        self.max_chance = attributes[:'max_chance']
+      else
+        self.max_chance = nil
+      end
+
+      if attributes.key?(:'encounter_details')
+        if (value = attributes[:'encounter_details']).is_a?(Array)
+          self.encounter_details = value
+        end
+      else
+        self.encounter_details = nil
+      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
+      if @version.nil?
+        invalid_properties.push('invalid value for "version", version cannot be nil.')
+      end
+
+      if @max_chance.nil?
+        invalid_properties.push('invalid value for "max_chance", max_chance cannot be nil.')
+      end
+
+      if @encounter_details.nil?
+        invalid_properties.push('invalid value for "encounter_details", encounter_details cannot be nil.')
+      end
+
+      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'
+      return false if @version.nil?
+      return false if @max_chance.nil?
+      return false if @encounter_details.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] version Value to be assigned
+    def version=(version)
+      if version.nil?
+        fail ArgumentError, 'version cannot be nil'
+      end
+
+      @version = version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_chance Value to be assigned
+    def max_chance=(max_chance)
+      if max_chance.nil?
+        fail ArgumentError, 'max_chance cannot be nil'
+      end
+
+      @max_chance = max_chance
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] encounter_details Value to be assigned
+    def encounter_details=(encounter_details)
+      if encounter_details.nil?
+        fail ArgumentError, 'encounter_details cannot be nil'
+      end
+
+      @encounter_details = encounter_details
+    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 &&
+          version == o.version &&
+          max_chance == o.max_chance &&
+          encounter_details == o.encounter_details
+    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
+      [version, max_chance, encounter_details].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)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[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[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end