pokeapi_client 1.1.0 → 2.0.0

data/lib/pokeapi_client/models/pokemon_detail.rb

@@ -0,0 +1,602 @@
+=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 PokemonDetail < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :base_experience
+
+    attr_accessor :height
+
+    attr_accessor :is_default
+
+    attr_accessor :order
+
+    attr_accessor :weight
+
+    attr_accessor :abilities
+
+    attr_accessor :past_abilities
+
+    attr_accessor :forms
+
+    attr_accessor :game_indices
+
+    attr_accessor :held_items
+
+    attr_accessor :location_area_encounters
+
+    attr_accessor :moves
+
+    attr_accessor :species
+
+    attr_accessor :sprites
+
+    attr_accessor :cries
+
+    attr_accessor :stats
+
+    attr_accessor :types
+
+    attr_accessor :past_types
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'base_experience' => :'base_experience',
+        :'height' => :'height',
+        :'is_default' => :'is_default',
+        :'order' => :'order',
+        :'weight' => :'weight',
+        :'abilities' => :'abilities',
+        :'past_abilities' => :'past_abilities',
+        :'forms' => :'forms',
+        :'game_indices' => :'game_indices',
+        :'held_items' => :'held_items',
+        :'location_area_encounters' => :'location_area_encounters',
+        :'moves' => :'moves',
+        :'species' => :'species',
+        :'sprites' => :'sprites',
+        :'cries' => :'cries',
+        :'stats' => :'stats',
+        :'types' => :'types',
+        :'past_types' => :'past_types'
+      }
+    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',
+        :'base_experience' => :'Integer',
+        :'height' => :'Integer',
+        :'is_default' => :'Boolean',
+        :'order' => :'Integer',
+        :'weight' => :'Integer',
+        :'abilities' => :'Array<PokemonDetailAbilitiesInner>',
+        :'past_abilities' => :'Array<PokemonDetailPastAbilitiesInner>',
+        :'forms' => :'Array<PokemonFormSummary>',
+        :'game_indices' => :'Array<PokemonGameIndex>',
+        :'held_items' => :'PokemonDetailHeldItems',
+        :'location_area_encounters' => :'String',
+        :'moves' => :'Array<PokemonDetailMovesInner>',
+        :'species' => :'PokemonSpeciesSummary',
+        :'sprites' => :'PokemonDetailSprites',
+        :'cries' => :'PokemonDetailCries',
+        :'stats' => :'Array<PokemonStat>',
+        :'types' => :'Array<PokemonDetailTypesInner>',
+        :'past_types' => :'Array<PokemonDetailPastTypesInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'base_experience',
+        :'height',
+        :'order',
+        :'weight',
+      ])
+    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::PokemonDetail` 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::PokemonDetail`. 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?(:'base_experience')
+        self.base_experience = attributes[:'base_experience']
+      end
+
+      if attributes.key?(:'height')
+        self.height = attributes[:'height']
+      end
+
+      if attributes.key?(:'is_default')
+        self.is_default = attributes[:'is_default']
+      end
+
+      if attributes.key?(:'order')
+        self.order = attributes[:'order']
+      end
+
+      if attributes.key?(:'weight')
+        self.weight = attributes[:'weight']
+      end
+
+      if attributes.key?(:'abilities')
+        if (value = attributes[:'abilities']).is_a?(Array)
+          self.abilities = value
+        end
+      else
+        self.abilities = nil
+      end
+
+      if attributes.key?(:'past_abilities')
+        if (value = attributes[:'past_abilities']).is_a?(Array)
+          self.past_abilities = value
+        end
+      else
+        self.past_abilities = nil
+      end
+
+      if attributes.key?(:'forms')
+        if (value = attributes[:'forms']).is_a?(Array)
+          self.forms = value
+        end
+      else
+        self.forms = nil
+      end
+
+      if attributes.key?(:'game_indices')
+        if (value = attributes[:'game_indices']).is_a?(Array)
+          self.game_indices = value
+        end
+      else
+        self.game_indices = nil
+      end
+
+      if attributes.key?(:'held_items')
+        self.held_items = attributes[:'held_items']
+      else
+        self.held_items = nil
+      end
+
+      if attributes.key?(:'location_area_encounters')
+        self.location_area_encounters = attributes[:'location_area_encounters']
+      else
+        self.location_area_encounters = nil
+      end
+
+      if attributes.key?(:'moves')
+        if (value = attributes[:'moves']).is_a?(Array)
+          self.moves = value
+        end
+      else
+        self.moves = nil
+      end
+
+      if attributes.key?(:'species')
+        self.species = attributes[:'species']
+      else
+        self.species = nil
+      end
+
+      if attributes.key?(:'sprites')
+        self.sprites = attributes[:'sprites']
+      else
+        self.sprites = nil
+      end
+
+      if attributes.key?(:'cries')
+        self.cries = attributes[:'cries']
+      else
+        self.cries = nil
+      end
+
+      if attributes.key?(:'stats')
+        if (value = attributes[:'stats']).is_a?(Array)
+          self.stats = value
+        end
+      else
+        self.stats = nil
+      end
+
+      if attributes.key?(:'types')
+        if (value = attributes[:'types']).is_a?(Array)
+          self.types = value
+        end
+      else
+        self.types = nil
+      end
+
+      if attributes.key?(:'past_types')
+        if (value = attributes[:'past_types']).is_a?(Array)
+          self.past_types = value
+        end
+      else
+        self.past_types = 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 @abilities.nil?
+        invalid_properties.push('invalid value for "abilities", abilities cannot be nil.')
+      end
+
+      if @past_abilities.nil?
+        invalid_properties.push('invalid value for "past_abilities", past_abilities cannot be nil.')
+      end
+
+      if @forms.nil?
+        invalid_properties.push('invalid value for "forms", forms cannot be nil.')
+      end
+
+      if @game_indices.nil?
+        invalid_properties.push('invalid value for "game_indices", game_indices cannot be nil.')
+      end
+
+      if @held_items.nil?
+        invalid_properties.push('invalid value for "held_items", held_items cannot be nil.')
+      end
+
+      if @location_area_encounters.nil?
+        invalid_properties.push('invalid value for "location_area_encounters", location_area_encounters cannot be nil.')
+      end
+
+      if @moves.nil?
+        invalid_properties.push('invalid value for "moves", moves cannot be nil.')
+      end
+
+      if @species.nil?
+        invalid_properties.push('invalid value for "species", species cannot be nil.')
+      end
+
+      if @sprites.nil?
+        invalid_properties.push('invalid value for "sprites", sprites cannot be nil.')
+      end
+
+      if @cries.nil?
+        invalid_properties.push('invalid value for "cries", cries cannot be nil.')
+      end
+
+      if @stats.nil?
+        invalid_properties.push('invalid value for "stats", stats cannot be nil.')
+      end
+
+      if @types.nil?
+        invalid_properties.push('invalid value for "types", types cannot be nil.')
+      end
+
+      if @past_types.nil?
+        invalid_properties.push('invalid value for "past_types", past_types 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 @abilities.nil?
+      return false if @past_abilities.nil?
+      return false if @forms.nil?
+      return false if @game_indices.nil?
+      return false if @held_items.nil?
+      return false if @location_area_encounters.nil?
+      return false if @moves.nil?
+      return false if @species.nil?
+      return false if @sprites.nil?
+      return false if @cries.nil?
+      return false if @stats.nil?
+      return false if @types.nil?
+      return false if @past_types.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] abilities Value to be assigned
+    def abilities=(abilities)
+      if abilities.nil?
+        fail ArgumentError, 'abilities cannot be nil'
+      end
+
+      @abilities = abilities
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] past_abilities Value to be assigned
+    def past_abilities=(past_abilities)
+      if past_abilities.nil?
+        fail ArgumentError, 'past_abilities cannot be nil'
+      end
+
+      @past_abilities = past_abilities
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] forms Value to be assigned
+    def forms=(forms)
+      if forms.nil?
+        fail ArgumentError, 'forms cannot be nil'
+      end
+
+      @forms = forms
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] game_indices Value to be assigned
+    def game_indices=(game_indices)
+      if game_indices.nil?
+        fail ArgumentError, 'game_indices cannot be nil'
+      end
+
+      @game_indices = game_indices
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] held_items Value to be assigned
+    def held_items=(held_items)
+      if held_items.nil?
+        fail ArgumentError, 'held_items cannot be nil'
+      end
+
+      @held_items = held_items
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] location_area_encounters Value to be assigned
+    def location_area_encounters=(location_area_encounters)
+      if location_area_encounters.nil?
+        fail ArgumentError, 'location_area_encounters cannot be nil'
+      end
+
+      @location_area_encounters = location_area_encounters
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] moves Value to be assigned
+    def moves=(moves)
+      if moves.nil?
+        fail ArgumentError, 'moves cannot be nil'
+      end
+
+      @moves = moves
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] species Value to be assigned
+    def species=(species)
+      if species.nil?
+        fail ArgumentError, 'species cannot be nil'
+      end
+
+      @species = species
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sprites Value to be assigned
+    def sprites=(sprites)
+      if sprites.nil?
+        fail ArgumentError, 'sprites cannot be nil'
+      end
+
+      @sprites = sprites
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cries Value to be assigned
+    def cries=(cries)
+      if cries.nil?
+        fail ArgumentError, 'cries cannot be nil'
+      end
+
+      @cries = cries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] stats Value to be assigned
+    def stats=(stats)
+      if stats.nil?
+        fail ArgumentError, 'stats cannot be nil'
+      end
+
+      @stats = stats
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] types Value to be assigned
+    def types=(types)
+      if types.nil?
+        fail ArgumentError, 'types cannot be nil'
+      end
+
+      @types = types
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] past_types Value to be assigned
+    def past_types=(past_types)
+      if past_types.nil?
+        fail ArgumentError, 'past_types cannot be nil'
+      end
+
+      @past_types = past_types
+    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 &&
+          base_experience == o.base_experience &&
+          height == o.height &&
+          is_default == o.is_default &&
+          order == o.order &&
+          weight == o.weight &&
+          abilities == o.abilities &&
+          past_abilities == o.past_abilities &&
+          forms == o.forms &&
+          game_indices == o.game_indices &&
+          held_items == o.held_items &&
+          location_area_encounters == o.location_area_encounters &&
+          moves == o.moves &&
+          species == o.species &&
+          sprites == o.sprites &&
+          cries == o.cries &&
+          stats == o.stats &&
+          types == o.types &&
+          past_types == o.past_types
+    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, base_experience, height, is_default, order, weight, abilities, past_abilities, forms, game_indices, held_items, location_area_encounters, moves, species, sprites, cries, stats, types, past_types].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