pokeapi_client 1.1.0 → 2.0.0

data/lib/pokeapi_client/models/pokemon_species_detail.rb

@@ -0,0 +1,700 @@
+=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.7.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PokeApiClient
+  class PokemonSpeciesDetail < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :order
+
+    attr_accessor :gender_rate
+
+    attr_accessor :capture_rate
+
+    attr_accessor :base_happiness
+
+    attr_accessor :is_baby
+
+    attr_accessor :is_legendary
+
+    attr_accessor :is_mythical
+
+    attr_accessor :hatch_counter
+
+    attr_accessor :has_gender_differences
+
+    attr_accessor :forms_switchable
+
+    attr_accessor :growth_rate
+
+    attr_accessor :pokedex_numbers
+
+    attr_accessor :egg_groups
+
+    attr_accessor :color
+
+    attr_accessor :shape
+
+    attr_accessor :evolves_from_species
+
+    attr_accessor :evolution_chain
+
+    attr_accessor :habitat
+
+    attr_accessor :generation
+
+    attr_accessor :names
+
+    attr_accessor :pal_park_encounters
+
+    attr_accessor :form_descriptions
+
+    attr_accessor :flavor_text_entries
+
+    attr_accessor :genera
+
+    attr_accessor :varieties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'order' => :'order',
+        :'gender_rate' => :'gender_rate',
+        :'capture_rate' => :'capture_rate',
+        :'base_happiness' => :'base_happiness',
+        :'is_baby' => :'is_baby',
+        :'is_legendary' => :'is_legendary',
+        :'is_mythical' => :'is_mythical',
+        :'hatch_counter' => :'hatch_counter',
+        :'has_gender_differences' => :'has_gender_differences',
+        :'forms_switchable' => :'forms_switchable',
+        :'growth_rate' => :'growth_rate',
+        :'pokedex_numbers' => :'pokedex_numbers',
+        :'egg_groups' => :'egg_groups',
+        :'color' => :'color',
+        :'shape' => :'shape',
+        :'evolves_from_species' => :'evolves_from_species',
+        :'evolution_chain' => :'evolution_chain',
+        :'habitat' => :'habitat',
+        :'generation' => :'generation',
+        :'names' => :'names',
+        :'pal_park_encounters' => :'pal_park_encounters',
+        :'form_descriptions' => :'form_descriptions',
+        :'flavor_text_entries' => :'flavor_text_entries',
+        :'genera' => :'genera',
+        :'varieties' => :'varieties'
+      }
+    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
+      {
+        :'id' => :'Integer',
+        :'name' => :'String',
+        :'order' => :'Integer',
+        :'gender_rate' => :'Integer',
+        :'capture_rate' => :'Integer',
+        :'base_happiness' => :'Integer',
+        :'is_baby' => :'Boolean',
+        :'is_legendary' => :'Boolean',
+        :'is_mythical' => :'Boolean',
+        :'hatch_counter' => :'Integer',
+        :'has_gender_differences' => :'Boolean',
+        :'forms_switchable' => :'Boolean',
+        :'growth_rate' => :'GrowthRateSummary',
+        :'pokedex_numbers' => :'Array<PokemonDexEntry>',
+        :'egg_groups' => :'Array<AbilityDetailPokemonInnerPokemon>',
+        :'color' => :'PokemonColorSummary',
+        :'shape' => :'PokemonShapeSummary',
+        :'evolves_from_species' => :'PokemonSpeciesSummary',
+        :'evolution_chain' => :'EvolutionChainSummary',
+        :'habitat' => :'PokemonHabitatSummary',
+        :'generation' => :'GenerationSummary',
+        :'names' => :'Array<PokemonFormDetailFormNamesInner>',
+        :'pal_park_encounters' => :'Array<PokemonSpeciesDetailPalParkEncountersInner>',
+        :'form_descriptions' => :'Array<PokemonSpeciesDescription>',
+        :'flavor_text_entries' => :'Array<PokemonSpeciesFlavorText>',
+        :'genera' => :'Array<PokemonSpeciesDetailGeneraInner>',
+        :'varieties' => :'Array<PokemonSpeciesDetailVarietiesInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'order',
+        :'gender_rate',
+        :'capture_rate',
+        :'base_happiness',
+        :'hatch_counter',
+      ])
+    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::PokemonSpeciesDetail` 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::PokemonSpeciesDetail`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'order')
+        self.order = attributes[:'order']
+      end
+
+      if attributes.key?(:'gender_rate')
+        self.gender_rate = attributes[:'gender_rate']
+      end
+
+      if attributes.key?(:'capture_rate')
+        self.capture_rate = attributes[:'capture_rate']
+      end
+
+      if attributes.key?(:'base_happiness')
+        self.base_happiness = attributes[:'base_happiness']
+      end
+
+      if attributes.key?(:'is_baby')
+        self.is_baby = attributes[:'is_baby']
+      end
+
+      if attributes.key?(:'is_legendary')
+        self.is_legendary = attributes[:'is_legendary']
+      end
+
+      if attributes.key?(:'is_mythical')
+        self.is_mythical = attributes[:'is_mythical']
+      end
+
+      if attributes.key?(:'hatch_counter')
+        self.hatch_counter = attributes[:'hatch_counter']
+      end
+
+      if attributes.key?(:'has_gender_differences')
+        self.has_gender_differences = attributes[:'has_gender_differences']
+      end
+
+      if attributes.key?(:'forms_switchable')
+        self.forms_switchable = attributes[:'forms_switchable']
+      end
+
+      if attributes.key?(:'growth_rate')
+        self.growth_rate = attributes[:'growth_rate']
+      else
+        self.growth_rate = nil
+      end
+
+      if attributes.key?(:'pokedex_numbers')
+        if (value = attributes[:'pokedex_numbers']).is_a?(Array)
+          self.pokedex_numbers = value
+        end
+      else
+        self.pokedex_numbers = nil
+      end
+
+      if attributes.key?(:'egg_groups')
+        if (value = attributes[:'egg_groups']).is_a?(Array)
+          self.egg_groups = value
+        end
+      else
+        self.egg_groups = nil
+      end
+
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      else
+        self.color = nil
+      end
+
+      if attributes.key?(:'shape')
+        self.shape = attributes[:'shape']
+      else
+        self.shape = nil
+      end
+
+      if attributes.key?(:'evolves_from_species')
+        self.evolves_from_species = attributes[:'evolves_from_species']
+      else
+        self.evolves_from_species = nil
+      end
+
+      if attributes.key?(:'evolution_chain')
+        self.evolution_chain = attributes[:'evolution_chain']
+      else
+        self.evolution_chain = nil
+      end
+
+      if attributes.key?(:'habitat')
+        self.habitat = attributes[:'habitat']
+      else
+        self.habitat = nil
+      end
+
+      if attributes.key?(:'generation')
+        self.generation = attributes[:'generation']
+      else
+        self.generation = nil
+      end
+
+      if attributes.key?(:'names')
+        if (value = attributes[:'names']).is_a?(Array)
+          self.names = value
+        end
+      else
+        self.names = nil
+      end
+
+      if attributes.key?(:'pal_park_encounters')
+        if (value = attributes[:'pal_park_encounters']).is_a?(Array)
+          self.pal_park_encounters = value
+        end
+      else
+        self.pal_park_encounters = nil
+      end
+
+      if attributes.key?(:'form_descriptions')
+        if (value = attributes[:'form_descriptions']).is_a?(Array)
+          self.form_descriptions = value
+        end
+      else
+        self.form_descriptions = nil
+      end
+
+      if attributes.key?(:'flavor_text_entries')
+        if (value = attributes[:'flavor_text_entries']).is_a?(Array)
+          self.flavor_text_entries = value
+        end
+      else
+        self.flavor_text_entries = nil
+      end
+
+      if attributes.key?(:'genera')
+        if (value = attributes[:'genera']).is_a?(Array)
+          self.genera = value
+        end
+      else
+        self.genera = nil
+      end
+
+      if attributes.key?(:'varieties')
+        if (value = attributes[:'varieties']).is_a?(Array)
+          self.varieties = value
+        end
+      else
+        self.varieties = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      end
+
+      if @growth_rate.nil?
+        invalid_properties.push('invalid value for "growth_rate", growth_rate cannot be nil.')
+      end
+
+      if @pokedex_numbers.nil?
+        invalid_properties.push('invalid value for "pokedex_numbers", pokedex_numbers cannot be nil.')
+      end
+
+      if @egg_groups.nil?
+        invalid_properties.push('invalid value for "egg_groups", egg_groups cannot be nil.')
+      end
+
+      if @color.nil?
+        invalid_properties.push('invalid value for "color", color cannot be nil.')
+      end
+
+      if @shape.nil?
+        invalid_properties.push('invalid value for "shape", shape cannot be nil.')
+      end
+
+      if @evolves_from_species.nil?
+        invalid_properties.push('invalid value for "evolves_from_species", evolves_from_species cannot be nil.')
+      end
+
+      if @evolution_chain.nil?
+        invalid_properties.push('invalid value for "evolution_chain", evolution_chain cannot be nil.')
+      end
+
+      if @habitat.nil?
+        invalid_properties.push('invalid value for "habitat", habitat cannot be nil.')
+      end
+
+      if @generation.nil?
+        invalid_properties.push('invalid value for "generation", generation cannot be nil.')
+      end
+
+      if @names.nil?
+        invalid_properties.push('invalid value for "names", names cannot be nil.')
+      end
+
+      if @pal_park_encounters.nil?
+        invalid_properties.push('invalid value for "pal_park_encounters", pal_park_encounters cannot be nil.')
+      end
+
+      if @form_descriptions.nil?
+        invalid_properties.push('invalid value for "form_descriptions", form_descriptions cannot be nil.')
+      end
+
+      if @flavor_text_entries.nil?
+        invalid_properties.push('invalid value for "flavor_text_entries", flavor_text_entries cannot be nil.')
+      end
+
+      if @genera.nil?
+        invalid_properties.push('invalid value for "genera", genera cannot be nil.')
+      end
+
+      if @varieties.nil?
+        invalid_properties.push('invalid value for "varieties", varieties 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 @id.nil?
+      return false if @name.nil?
+      return false if @name.to_s.length > 100
+      return false if @growth_rate.nil?
+      return false if @pokedex_numbers.nil?
+      return false if @egg_groups.nil?
+      return false if @color.nil?
+      return false if @shape.nil?
+      return false if @evolves_from_species.nil?
+      return false if @evolution_chain.nil?
+      return false if @habitat.nil?
+      return false if @generation.nil?
+      return false if @names.nil?
+      return false if @pal_park_encounters.nil?
+      return false if @form_descriptions.nil?
+      return false if @flavor_text_entries.nil?
+      return false if @genera.nil?
+      return false if @varieties.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] growth_rate Value to be assigned
+    def growth_rate=(growth_rate)
+      if growth_rate.nil?
+        fail ArgumentError, 'growth_rate cannot be nil'
+      end
+
+      @growth_rate = growth_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pokedex_numbers Value to be assigned
+    def pokedex_numbers=(pokedex_numbers)
+      if pokedex_numbers.nil?
+        fail ArgumentError, 'pokedex_numbers cannot be nil'
+      end
+
+      @pokedex_numbers = pokedex_numbers
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] egg_groups Value to be assigned
+    def egg_groups=(egg_groups)
+      if egg_groups.nil?
+        fail ArgumentError, 'egg_groups cannot be nil'
+      end
+
+      @egg_groups = egg_groups
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] color Value to be assigned
+    def color=(color)
+      if color.nil?
+        fail ArgumentError, 'color cannot be nil'
+      end
+
+      @color = color
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] shape Value to be assigned
+    def shape=(shape)
+      if shape.nil?
+        fail ArgumentError, 'shape cannot be nil'
+      end
+
+      @shape = shape
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] evolves_from_species Value to be assigned
+    def evolves_from_species=(evolves_from_species)
+      if evolves_from_species.nil?
+        fail ArgumentError, 'evolves_from_species cannot be nil'
+      end
+
+      @evolves_from_species = evolves_from_species
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] evolution_chain Value to be assigned
+    def evolution_chain=(evolution_chain)
+      if evolution_chain.nil?
+        fail ArgumentError, 'evolution_chain cannot be nil'
+      end
+
+      @evolution_chain = evolution_chain
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] habitat Value to be assigned
+    def habitat=(habitat)
+      if habitat.nil?
+        fail ArgumentError, 'habitat cannot be nil'
+      end
+
+      @habitat = habitat
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] generation Value to be assigned
+    def generation=(generation)
+      if generation.nil?
+        fail ArgumentError, 'generation cannot be nil'
+      end
+
+      @generation = generation
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] names Value to be assigned
+    def names=(names)
+      if names.nil?
+        fail ArgumentError, 'names cannot be nil'
+      end
+
+      @names = names
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pal_park_encounters Value to be assigned
+    def pal_park_encounters=(pal_park_encounters)
+      if pal_park_encounters.nil?
+        fail ArgumentError, 'pal_park_encounters cannot be nil'
+      end
+
+      @pal_park_encounters = pal_park_encounters
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] form_descriptions Value to be assigned
+    def form_descriptions=(form_descriptions)
+      if form_descriptions.nil?
+        fail ArgumentError, 'form_descriptions cannot be nil'
+      end
+
+      @form_descriptions = form_descriptions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] flavor_text_entries Value to be assigned
+    def flavor_text_entries=(flavor_text_entries)
+      if flavor_text_entries.nil?
+        fail ArgumentError, 'flavor_text_entries cannot be nil'
+      end
+
+      @flavor_text_entries = flavor_text_entries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] genera Value to be assigned
+    def genera=(genera)
+      if genera.nil?
+        fail ArgumentError, 'genera cannot be nil'
+      end
+
+      @genera = genera
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] varieties Value to be assigned
+    def varieties=(varieties)
+      if varieties.nil?
+        fail ArgumentError, 'varieties cannot be nil'
+      end
+
+      @varieties = varieties
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          order == o.order &&
+          gender_rate == o.gender_rate &&
+          capture_rate == o.capture_rate &&
+          base_happiness == o.base_happiness &&
+          is_baby == o.is_baby &&
+          is_legendary == o.is_legendary &&
+          is_mythical == o.is_mythical &&
+          hatch_counter == o.hatch_counter &&
+          has_gender_differences == o.has_gender_differences &&
+          forms_switchable == o.forms_switchable &&
+          growth_rate == o.growth_rate &&
+          pokedex_numbers == o.pokedex_numbers &&
+          egg_groups == o.egg_groups &&
+          color == o.color &&
+          shape == o.shape &&
+          evolves_from_species == o.evolves_from_species &&
+          evolution_chain == o.evolution_chain &&
+          habitat == o.habitat &&
+          generation == o.generation &&
+          names == o.names &&
+          pal_park_encounters == o.pal_park_encounters &&
+          form_descriptions == o.form_descriptions &&
+          flavor_text_entries == o.flavor_text_entries &&
+          genera == o.genera &&
+          varieties == o.varieties
+    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
+      [id, name, order, gender_rate, capture_rate, base_happiness, is_baby, is_legendary, is_mythical, hatch_counter, has_gender_differences, forms_switchable, growth_rate, pokedex_numbers, egg_groups, color, shape, evolves_from_species, evolution_chain, habitat, generation, names, pal_park_encounters, form_descriptions, flavor_text_entries, genera, varieties].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
+
+    # 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
+
+  end
+
+end