pokeapi_client 1.2.0 → 2.0.0

data/lib/pokeapi_client/models/move_detail.rb

@@ -0,0 +1,723 @@
+=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 MoveDetail < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :accuracy
+
+    attr_accessor :effect_chance
+
+    attr_accessor :pp
+
+    attr_accessor :priority
+
+    attr_accessor :power
+
+    attr_accessor :contest_combos
+
+    attr_accessor :contest_type
+
+    attr_accessor :contest_effect
+
+    attr_accessor :damage_class
+
+    attr_accessor :effect_entries
+
+    attr_accessor :effect_changes
+
+    attr_accessor :generation
+
+    attr_accessor :meta
+
+    attr_accessor :names
+
+    attr_accessor :past_values
+
+    attr_accessor :stat_changes
+
+    attr_accessor :super_contest_effect
+
+    attr_accessor :target
+
+    attr_accessor :type
+
+    attr_accessor :machines
+
+    attr_accessor :flavor_text_entries
+
+    attr_accessor :learned_by_pokemon
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'accuracy' => :'accuracy',
+        :'effect_chance' => :'effect_chance',
+        :'pp' => :'pp',
+        :'priority' => :'priority',
+        :'power' => :'power',
+        :'contest_combos' => :'contest_combos',
+        :'contest_type' => :'contest_type',
+        :'contest_effect' => :'contest_effect',
+        :'damage_class' => :'damage_class',
+        :'effect_entries' => :'effect_entries',
+        :'effect_changes' => :'effect_changes',
+        :'generation' => :'generation',
+        :'meta' => :'meta',
+        :'names' => :'names',
+        :'past_values' => :'past_values',
+        :'stat_changes' => :'stat_changes',
+        :'super_contest_effect' => :'super_contest_effect',
+        :'target' => :'target',
+        :'type' => :'type',
+        :'machines' => :'machines',
+        :'flavor_text_entries' => :'flavor_text_entries',
+        :'learned_by_pokemon' => :'learned_by_pokemon'
+      }
+    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',
+        :'accuracy' => :'Integer',
+        :'effect_chance' => :'Integer',
+        :'pp' => :'Integer',
+        :'priority' => :'Integer',
+        :'power' => :'Integer',
+        :'contest_combos' => :'MoveDetailContestCombos',
+        :'contest_type' => :'ContestTypeSummary',
+        :'contest_effect' => :'ContestEffectSummary',
+        :'damage_class' => :'MoveDamageClassSummary',
+        :'effect_entries' => :'Array<MoveChangeEffectEntriesInner>',
+        :'effect_changes' => :'Array<MoveDetailEffectChangesInner>',
+        :'generation' => :'GenerationSummary',
+        :'meta' => :'MoveMeta',
+        :'names' => :'Array<MoveName>',
+        :'past_values' => :'Array<MoveChange>',
+        :'stat_changes' => :'Array<MoveDetailStatChangesInner>',
+        :'super_contest_effect' => :'SuperContestEffectSummary',
+        :'target' => :'MoveTargetSummary',
+        :'type' => :'TypeSummary',
+        :'machines' => :'Array<MoveDetailMachinesInner>',
+        :'flavor_text_entries' => :'Array<MoveFlavorText>',
+        :'learned_by_pokemon' => :'Array<AbilityDetailPokemonInnerPokemon>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'accuracy',
+        :'pp',
+        :'priority',
+        :'power',
+      ])
+    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::MoveDetail` 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::MoveDetail`. 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?(:'accuracy')
+        self.accuracy = attributes[:'accuracy']
+      end
+
+      if attributes.key?(:'effect_chance')
+        self.effect_chance = attributes[:'effect_chance']
+      else
+        self.effect_chance = nil
+      end
+
+      if attributes.key?(:'pp')
+        self.pp = attributes[:'pp']
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'power')
+        self.power = attributes[:'power']
+      end
+
+      if attributes.key?(:'contest_combos')
+        self.contest_combos = attributes[:'contest_combos']
+      else
+        self.contest_combos = nil
+      end
+
+      if attributes.key?(:'contest_type')
+        self.contest_type = attributes[:'contest_type']
+      else
+        self.contest_type = nil
+      end
+
+      if attributes.key?(:'contest_effect')
+        self.contest_effect = attributes[:'contest_effect']
+      else
+        self.contest_effect = nil
+      end
+
+      if attributes.key?(:'damage_class')
+        self.damage_class = attributes[:'damage_class']
+      else
+        self.damage_class = nil
+      end
+
+      if attributes.key?(:'effect_entries')
+        if (value = attributes[:'effect_entries']).is_a?(Array)
+          self.effect_entries = value
+        end
+      else
+        self.effect_entries = nil
+      end
+
+      if attributes.key?(:'effect_changes')
+        if (value = attributes[:'effect_changes']).is_a?(Array)
+          self.effect_changes = value
+        end
+      else
+        self.effect_changes = nil
+      end
+
+      if attributes.key?(:'generation')
+        self.generation = attributes[:'generation']
+      else
+        self.generation = nil
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      else
+        self.meta = 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?(:'past_values')
+        if (value = attributes[:'past_values']).is_a?(Array)
+          self.past_values = value
+        end
+      else
+        self.past_values = nil
+      end
+
+      if attributes.key?(:'stat_changes')
+        if (value = attributes[:'stat_changes']).is_a?(Array)
+          self.stat_changes = value
+        end
+      else
+        self.stat_changes = nil
+      end
+
+      if attributes.key?(:'super_contest_effect')
+        self.super_contest_effect = attributes[:'super_contest_effect']
+      else
+        self.super_contest_effect = nil
+      end
+
+      if attributes.key?(:'target')
+        self.target = attributes[:'target']
+      else
+        self.target = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'machines')
+        if (value = attributes[:'machines']).is_a?(Array)
+          self.machines = value
+        end
+      else
+        self.machines = 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?(:'learned_by_pokemon')
+        if (value = attributes[:'learned_by_pokemon']).is_a?(Array)
+          self.learned_by_pokemon = value
+        end
+      else
+        self.learned_by_pokemon = 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 @effect_chance.nil?
+        invalid_properties.push('invalid value for "effect_chance", effect_chance cannot be nil.')
+      end
+
+      if @contest_combos.nil?
+        invalid_properties.push('invalid value for "contest_combos", contest_combos cannot be nil.')
+      end
+
+      if @contest_type.nil?
+        invalid_properties.push('invalid value for "contest_type", contest_type cannot be nil.')
+      end
+
+      if @contest_effect.nil?
+        invalid_properties.push('invalid value for "contest_effect", contest_effect cannot be nil.')
+      end
+
+      if @damage_class.nil?
+        invalid_properties.push('invalid value for "damage_class", damage_class cannot be nil.')
+      end
+
+      if @effect_entries.nil?
+        invalid_properties.push('invalid value for "effect_entries", effect_entries cannot be nil.')
+      end
+
+      if @effect_changes.nil?
+        invalid_properties.push('invalid value for "effect_changes", effect_changes cannot be nil.')
+      end
+
+      if @generation.nil?
+        invalid_properties.push('invalid value for "generation", generation cannot be nil.')
+      end
+
+      if @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta cannot be nil.')
+      end
+
+      if @names.nil?
+        invalid_properties.push('invalid value for "names", names cannot be nil.')
+      end
+
+      if @past_values.nil?
+        invalid_properties.push('invalid value for "past_values", past_values cannot be nil.')
+      end
+
+      if @stat_changes.nil?
+        invalid_properties.push('invalid value for "stat_changes", stat_changes cannot be nil.')
+      end
+
+      if @super_contest_effect.nil?
+        invalid_properties.push('invalid value for "super_contest_effect", super_contest_effect cannot be nil.')
+      end
+
+      if @target.nil?
+        invalid_properties.push('invalid value for "target", target cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @machines.nil?
+        invalid_properties.push('invalid value for "machines", machines 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 @learned_by_pokemon.nil?
+        invalid_properties.push('invalid value for "learned_by_pokemon", learned_by_pokemon 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 @effect_chance.nil?
+      return false if @contest_combos.nil?
+      return false if @contest_type.nil?
+      return false if @contest_effect.nil?
+      return false if @damage_class.nil?
+      return false if @effect_entries.nil?
+      return false if @effect_changes.nil?
+      return false if @generation.nil?
+      return false if @meta.nil?
+      return false if @names.nil?
+      return false if @past_values.nil?
+      return false if @stat_changes.nil?
+      return false if @super_contest_effect.nil?
+      return false if @target.nil?
+      return false if @type.nil?
+      return false if @machines.nil?
+      return false if @flavor_text_entries.nil?
+      return false if @learned_by_pokemon.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] effect_chance Value to be assigned
+    def effect_chance=(effect_chance)
+      if effect_chance.nil?
+        fail ArgumentError, 'effect_chance cannot be nil'
+      end
+
+      @effect_chance = effect_chance
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contest_combos Value to be assigned
+    def contest_combos=(contest_combos)
+      if contest_combos.nil?
+        fail ArgumentError, 'contest_combos cannot be nil'
+      end
+
+      @contest_combos = contest_combos
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contest_type Value to be assigned
+    def contest_type=(contest_type)
+      if contest_type.nil?
+        fail ArgumentError, 'contest_type cannot be nil'
+      end
+
+      @contest_type = contest_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contest_effect Value to be assigned
+    def contest_effect=(contest_effect)
+      if contest_effect.nil?
+        fail ArgumentError, 'contest_effect cannot be nil'
+      end
+
+      @contest_effect = contest_effect
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] damage_class Value to be assigned
+    def damage_class=(damage_class)
+      if damage_class.nil?
+        fail ArgumentError, 'damage_class cannot be nil'
+      end
+
+      @damage_class = damage_class
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] effect_entries Value to be assigned
+    def effect_entries=(effect_entries)
+      if effect_entries.nil?
+        fail ArgumentError, 'effect_entries cannot be nil'
+      end
+
+      @effect_entries = effect_entries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] effect_changes Value to be assigned
+    def effect_changes=(effect_changes)
+      if effect_changes.nil?
+        fail ArgumentError, 'effect_changes cannot be nil'
+      end
+
+      @effect_changes = effect_changes
+    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] meta Value to be assigned
+    def meta=(meta)
+      if meta.nil?
+        fail ArgumentError, 'meta cannot be nil'
+      end
+
+      @meta = meta
+    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] past_values Value to be assigned
+    def past_values=(past_values)
+      if past_values.nil?
+        fail ArgumentError, 'past_values cannot be nil'
+      end
+
+      @past_values = past_values
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] stat_changes Value to be assigned
+    def stat_changes=(stat_changes)
+      if stat_changes.nil?
+        fail ArgumentError, 'stat_changes cannot be nil'
+      end
+
+      @stat_changes = stat_changes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] super_contest_effect Value to be assigned
+    def super_contest_effect=(super_contest_effect)
+      if super_contest_effect.nil?
+        fail ArgumentError, 'super_contest_effect cannot be nil'
+      end
+
+      @super_contest_effect = super_contest_effect
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target Value to be assigned
+    def target=(target)
+      if target.nil?
+        fail ArgumentError, 'target cannot be nil'
+      end
+
+      @target = target
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] machines Value to be assigned
+    def machines=(machines)
+      if machines.nil?
+        fail ArgumentError, 'machines cannot be nil'
+      end
+
+      @machines = machines
+    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] learned_by_pokemon Value to be assigned
+    def learned_by_pokemon=(learned_by_pokemon)
+      if learned_by_pokemon.nil?
+        fail ArgumentError, 'learned_by_pokemon cannot be nil'
+      end
+
+      @learned_by_pokemon = learned_by_pokemon
+    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 &&
+          accuracy == o.accuracy &&
+          effect_chance == o.effect_chance &&
+          pp == o.pp &&
+          priority == o.priority &&
+          power == o.power &&
+          contest_combos == o.contest_combos &&
+          contest_type == o.contest_type &&
+          contest_effect == o.contest_effect &&
+          damage_class == o.damage_class &&
+          effect_entries == o.effect_entries &&
+          effect_changes == o.effect_changes &&
+          generation == o.generation &&
+          meta == o.meta &&
+          names == o.names &&
+          past_values == o.past_values &&
+          stat_changes == o.stat_changes &&
+          super_contest_effect == o.super_contest_effect &&
+          target == o.target &&
+          type == o.type &&
+          machines == o.machines &&
+          flavor_text_entries == o.flavor_text_entries &&
+          learned_by_pokemon == o.learned_by_pokemon
+    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, accuracy, effect_chance, pp, priority, power, contest_combos, contest_type, contest_effect, damage_class, effect_entries, effect_changes, generation, meta, names, past_values, stat_changes, super_contest_effect, target, type, machines, flavor_text_entries, learned_by_pokemon].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