pokeapi_client
PokeApiClient - the Ruby gem for the
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 20220523
- Package version: 1.1.0
- Generator version: 7.6.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://github.com/oapicf/pokeapi-clients
Installation
Build a gem
To build the Ruby code into a gem:
gem build pokeapi_client.gemspec
Then either install the gem locally:
gem install ./pokeapi_client-1.1.0.gem
(for development, run gem install --dev ./pokeapi_client-1.1.0.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'pokeapi_client', '~> 1.1.0'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'pokeapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'pokeapi_client'
api_instance = PokeApiClient::AbilityApi.new
opts = {
limit: 56, # Integer |
offset: 56 # Integer |
}
begin
result = api_instance.ability_list(opts)
p result
rescue PokeApiClient::ApiError => e
puts "Exception when calling AbilityApi->ability_list: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://pokeapi.co
| Class | Method | HTTP request | Description |
|---|---|---|---|
| PokeApiClient::AbilityApi | ability_list | GET /api/v2/ability/ | |
| PokeApiClient::AbilityApi | ability_read | GET /api/v2/ability/id/ | |
| PokeApiClient::BerryApi | berry_list | GET /api/v2/berry/ | |
| PokeApiClient::BerryApi | berry_read | GET /api/v2/berry/id/ | |
| PokeApiClient::BerryFirmnessApi | berry_firmness_list | GET /api/v2/berry-firmness/ | |
| PokeApiClient::BerryFirmnessApi | berry_firmness_read | GET /api/v2/berry-firmness/id/ | |
| PokeApiClient::BerryFlavorApi | berry_flavor_list | GET /api/v2/berry-flavor/ | |
| PokeApiClient::BerryFlavorApi | berry_flavor_read | GET /api/v2/berry-flavor/id/ | |
| PokeApiClient::CharacteristicApi | characteristic_list | GET /api/v2/characteristic/ | |
| PokeApiClient::CharacteristicApi | characteristic_read | GET /api/v2/characteristic/id/ | |
| PokeApiClient::ContestEffectApi | contest_effect_list | GET /api/v2/contest-effect/ | |
| PokeApiClient::ContestEffectApi | contest_effect_read | GET /api/v2/contest-effect/id/ | |
| PokeApiClient::ContestTypeApi | contest_type_list | GET /api/v2/contest-type/ | |
| PokeApiClient::ContestTypeApi | contest_type_read | GET /api/v2/contest-type/id/ | |
| PokeApiClient::EggGroupApi | egg_group_list | GET /api/v2/egg-group/ | |
| PokeApiClient::EggGroupApi | egg_group_read | GET /api/v2/egg-group/id/ | |
| PokeApiClient::EncounterConditionApi | encounter_condition_list | GET /api/v2/encounter-condition/ | |
| PokeApiClient::EncounterConditionApi | encounter_condition_read | GET /api/v2/encounter-condition/id/ | |
| PokeApiClient::EncounterConditionValueApi | encounter_condition_value_list | GET /api/v2/encounter-condition-value/ | |
| PokeApiClient::EncounterConditionValueApi | encounter_condition_value_read | GET /api/v2/encounter-condition-value/id/ | |
| PokeApiClient::EncounterMethodApi | encounter_method_list | GET /api/v2/encounter-method/ | |
| PokeApiClient::EncounterMethodApi | encounter_method_read | GET /api/v2/encounter-method/id/ | |
| PokeApiClient::EvolutionChainApi | evolution_chain_list | GET /api/v2/evolution-chain/ | |
| PokeApiClient::EvolutionChainApi | evolution_chain_read | GET /api/v2/evolution-chain/id/ | |
| PokeApiClient::EvolutionTriggerApi | evolution_trigger_list | GET /api/v2/evolution-trigger/ | |
| PokeApiClient::EvolutionTriggerApi | evolution_trigger_read | GET /api/v2/evolution-trigger/id/ | |
| PokeApiClient::GenderApi | gender_list | GET /api/v2/gender/ | |
| PokeApiClient::GenderApi | gender_read | GET /api/v2/gender/id/ | |
| PokeApiClient::GenerationApi | generation_list | GET /api/v2/generation/ | |
| PokeApiClient::GenerationApi | generation_read | GET /api/v2/generation/id/ | |
| PokeApiClient::GrowthRateApi | growth_rate_list | GET /api/v2/growth-rate/ | |
| PokeApiClient::GrowthRateApi | growth_rate_read | GET /api/v2/growth-rate/id/ | |
| PokeApiClient::ItemApi | item_list | GET /api/v2/item/ | |
| PokeApiClient::ItemApi | item_read | GET /api/v2/item/id/ | |
| PokeApiClient::ItemAttributeApi | item_attribute_list | GET /api/v2/item-attribute/ | |
| PokeApiClient::ItemAttributeApi | item_attribute_read | GET /api/v2/item-attribute/id/ | |
| PokeApiClient::ItemCategoryApi | item_category_list | GET /api/v2/item-category/ | |
| PokeApiClient::ItemCategoryApi | item_category_read | GET /api/v2/item-category/id/ | |
| PokeApiClient::ItemFlingEffectApi | item_fling_effect_list | GET /api/v2/item-fling-effect/ | |
| PokeApiClient::ItemFlingEffectApi | item_fling_effect_read | GET /api/v2/item-fling-effect/id/ | |
| PokeApiClient::ItemPocketApi | item_pocket_list | GET /api/v2/item-pocket/ | |
| PokeApiClient::ItemPocketApi | item_pocket_read | GET /api/v2/item-pocket/id/ | |
| PokeApiClient::LanguageApi | language_list | GET /api/v2/language/ | |
| PokeApiClient::LanguageApi | language_read | GET /api/v2/language/id/ | |
| PokeApiClient::LocationApi | location_list | GET /api/v2/location/ | |
| PokeApiClient::LocationApi | location_read | GET /api/v2/location/id/ | |
| PokeApiClient::LocationAreaApi | location_area_list | GET /api/v2/location-area/ | |
| PokeApiClient::LocationAreaApi | location_area_read | GET /api/v2/location-area/id/ | |
| PokeApiClient::MachineApi | machine_list | GET /api/v2/machine/ | |
| PokeApiClient::MachineApi | machine_read | GET /api/v2/machine/id/ | |
| PokeApiClient::MoveApi | move_list | GET /api/v2/move/ | |
| PokeApiClient::MoveApi | move_read | GET /api/v2/move/id/ | |
| PokeApiClient::MoveAilmentApi | move_ailment_list | GET /api/v2/move-ailment/ | |
| PokeApiClient::MoveAilmentApi | move_ailment_read | GET /api/v2/move-ailment/id/ | |
| PokeApiClient::MoveBattleStyleApi | move_battle_style_list | GET /api/v2/move-battle-style/ | |
| PokeApiClient::MoveBattleStyleApi | move_battle_style_read | GET /api/v2/move-battle-style/id/ | |
| PokeApiClient::MoveCategoryApi | move_category_list | GET /api/v2/move-category/ | |
| PokeApiClient::MoveCategoryApi | move_category_read | GET /api/v2/move-category/id/ | |
| PokeApiClient::MoveDamageClassApi | move_damage_class_list | GET /api/v2/move-damage-class/ | |
| PokeApiClient::MoveDamageClassApi | move_damage_class_read | GET /api/v2/move-damage-class/id/ | |
| PokeApiClient::MoveLearnMethodApi | move_learn_method_list | GET /api/v2/move-learn-method/ | |
| PokeApiClient::MoveLearnMethodApi | move_learn_method_read | GET /api/v2/move-learn-method/id/ | |
| PokeApiClient::MoveTargetApi | move_target_list | GET /api/v2/move-target/ | |
| PokeApiClient::MoveTargetApi | move_target_read | GET /api/v2/move-target/id/ | |
| PokeApiClient::NatureApi | nature_list | GET /api/v2/nature/ | |
| PokeApiClient::NatureApi | nature_read | GET /api/v2/nature/id/ | |
| PokeApiClient::PalParkAreaApi | pal_park_area_list | GET /api/v2/pal-park-area/ | |
| PokeApiClient::PalParkAreaApi | pal_park_area_read | GET /api/v2/pal-park-area/id/ | |
| PokeApiClient::PokeathlonStatApi | pokeathlon_stat_list | GET /api/v2/pokeathlon-stat/ | |
| PokeApiClient::PokeathlonStatApi | pokeathlon_stat_read | GET /api/v2/pokeathlon-stat/id/ | |
| PokeApiClient::PokedexApi | pokedex_list | GET /api/v2/pokedex/ | |
| PokeApiClient::PokedexApi | pokedex_read | GET /api/v2/pokedex/id/ | |
| PokeApiClient::PokemonApi | pokemon_list | GET /api/v2/pokemon/ | |
| PokeApiClient::PokemonApi | pokemon_read | GET /api/v2/pokemon/id/ | |
| PokeApiClient::PokemonColorApi | pokemon_color_list | GET /api/v2/pokemon-color/ | |
| PokeApiClient::PokemonColorApi | pokemon_color_read | GET /api/v2/pokemon-color/id/ | |
| PokeApiClient::PokemonFormApi | pokemon_form_list | GET /api/v2/pokemon-form/ | |
| PokeApiClient::PokemonFormApi | pokemon_form_read | GET /api/v2/pokemon-form/id/ | |
| PokeApiClient::PokemonHabitatApi | pokemon_habitat_list | GET /api/v2/pokemon-habitat/ | |
| PokeApiClient::PokemonHabitatApi | pokemon_habitat_read | GET /api/v2/pokemon-habitat/id/ | |
| PokeApiClient::PokemonShapeApi | pokemon_shape_list | GET /api/v2/pokemon-shape/ | |
| PokeApiClient::PokemonShapeApi | pokemon_shape_read | GET /api/v2/pokemon-shape/id/ | |
| PokeApiClient::PokemonSpeciesApi | pokemon_species_list | GET /api/v2/pokemon-species/ | |
| PokeApiClient::PokemonSpeciesApi | pokemon_species_read | GET /api/v2/pokemon-species/id/ | |
| PokeApiClient::RegionApi | region_list | GET /api/v2/region/ | |
| PokeApiClient::RegionApi | region_read | GET /api/v2/region/id/ | |
| PokeApiClient::StatApi | stat_list | GET /api/v2/stat/ | |
| PokeApiClient::StatApi | stat_read | GET /api/v2/stat/id/ | |
| PokeApiClient::SuperContestEffectApi | super_contest_effect_list | GET /api/v2/super-contest-effect/ | |
| PokeApiClient::SuperContestEffectApi | super_contest_effect_read | GET /api/v2/super-contest-effect/id/ | |
| PokeApiClient::TypeApi | type_list | GET /api/v2/type/ | |
| PokeApiClient::TypeApi | type_read | GET /api/v2/type/id/ | |
| PokeApiClient::VersionApi | version_list | GET /api/v2/version/ | |
| PokeApiClient::VersionApi | version_read | GET /api/v2/version/id/ | |
| PokeApiClient::VersionGroupApi | version_group_list | GET /api/v2/version-group/ | |
| PokeApiClient::VersionGroupApi | version_group_read | GET /api/v2/version-group/id/ |
Documentation for Models
Documentation for Authorization
Endpoints do not require authorization.