pokeapi-client

pokeapi-client

PokeapiClient - JavaScript client for pokeapi-client 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.JavascriptClientCodegen For more information, please visit https://github.com/oapicf/pokeapi-clients

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install pokeapi-client --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your pokeapi-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/oapicf/pokeapi-clients then install it via:

    npm install oapicf/pokeapi-clients --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var PokeapiClient = require('pokeapi-client');


var api = new PokeapiClient.AbilityApi()
var opts = {
  'limit': 56, // {Number} 
  'offset': 56 // {Number} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.abilityList(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://pokeapi.co

Class	Method	HTTP request	Description
PokeapiClient.AbilityApi	abilityList	GET /api/v2/ability/
PokeapiClient.AbilityApi	abilityRead	GET /api/v2/ability/{id}/
PokeapiClient.BerryApi	berryList	GET /api/v2/berry/
PokeapiClient.BerryApi	berryRead	GET /api/v2/berry/{id}/
PokeapiClient.BerryFirmnessApi	berryFirmnessList	GET /api/v2/berry-firmness/
PokeapiClient.BerryFirmnessApi	berryFirmnessRead	GET /api/v2/berry-firmness/{id}/
PokeapiClient.BerryFlavorApi	berryFlavorList	GET /api/v2/berry-flavor/
PokeapiClient.BerryFlavorApi	berryFlavorRead	GET /api/v2/berry-flavor/{id}/
PokeapiClient.CharacteristicApi	characteristicList	GET /api/v2/characteristic/
PokeapiClient.CharacteristicApi	characteristicRead	GET /api/v2/characteristic/{id}/
PokeapiClient.ContestEffectApi	contestEffectList	GET /api/v2/contest-effect/
PokeapiClient.ContestEffectApi	contestEffectRead	GET /api/v2/contest-effect/{id}/
PokeapiClient.ContestTypeApi	contestTypeList	GET /api/v2/contest-type/
PokeapiClient.ContestTypeApi	contestTypeRead	GET /api/v2/contest-type/{id}/
PokeapiClient.EggGroupApi	eggGroupList	GET /api/v2/egg-group/
PokeapiClient.EggGroupApi	eggGroupRead	GET /api/v2/egg-group/{id}/
PokeapiClient.EncounterConditionApi	encounterConditionList	GET /api/v2/encounter-condition/
PokeapiClient.EncounterConditionApi	encounterConditionRead	GET /api/v2/encounter-condition/{id}/
PokeapiClient.EncounterConditionValueApi	encounterConditionValueList	GET /api/v2/encounter-condition-value/
PokeapiClient.EncounterConditionValueApi	encounterConditionValueRead	GET /api/v2/encounter-condition-value/{id}/
PokeapiClient.EncounterMethodApi	encounterMethodList	GET /api/v2/encounter-method/
PokeapiClient.EncounterMethodApi	encounterMethodRead	GET /api/v2/encounter-method/{id}/
PokeapiClient.EvolutionChainApi	evolutionChainList	GET /api/v2/evolution-chain/
PokeapiClient.EvolutionChainApi	evolutionChainRead	GET /api/v2/evolution-chain/{id}/
PokeapiClient.EvolutionTriggerApi	evolutionTriggerList	GET /api/v2/evolution-trigger/
PokeapiClient.EvolutionTriggerApi	evolutionTriggerRead	GET /api/v2/evolution-trigger/{id}/
PokeapiClient.GenderApi	genderList	GET /api/v2/gender/
PokeapiClient.GenderApi	genderRead	GET /api/v2/gender/{id}/
PokeapiClient.GenerationApi	generationList	GET /api/v2/generation/
PokeapiClient.GenerationApi	generationRead	GET /api/v2/generation/{id}/
PokeapiClient.GrowthRateApi	growthRateList	GET /api/v2/growth-rate/
PokeapiClient.GrowthRateApi	growthRateRead	GET /api/v2/growth-rate/{id}/
PokeapiClient.ItemApi	itemList	GET /api/v2/item/
PokeapiClient.ItemApi	itemRead	GET /api/v2/item/{id}/
PokeapiClient.ItemAttributeApi	itemAttributeList	GET /api/v2/item-attribute/
PokeapiClient.ItemAttributeApi	itemAttributeRead	GET /api/v2/item-attribute/{id}/
PokeapiClient.ItemCategoryApi	itemCategoryList	GET /api/v2/item-category/
PokeapiClient.ItemCategoryApi	itemCategoryRead	GET /api/v2/item-category/{id}/
PokeapiClient.ItemFlingEffectApi	itemFlingEffectList	GET /api/v2/item-fling-effect/
PokeapiClient.ItemFlingEffectApi	itemFlingEffectRead	GET /api/v2/item-fling-effect/{id}/
PokeapiClient.ItemPocketApi	itemPocketList	GET /api/v2/item-pocket/
PokeapiClient.ItemPocketApi	itemPocketRead	GET /api/v2/item-pocket/{id}/
PokeapiClient.LanguageApi	languageList	GET /api/v2/language/
PokeapiClient.LanguageApi	languageRead	GET /api/v2/language/{id}/
PokeapiClient.LocationApi	locationList	GET /api/v2/location/
PokeapiClient.LocationApi	locationRead	GET /api/v2/location/{id}/
PokeapiClient.LocationAreaApi	locationAreaList	GET /api/v2/location-area/
PokeapiClient.LocationAreaApi	locationAreaRead	GET /api/v2/location-area/{id}/
PokeapiClient.MachineApi	machineList	GET /api/v2/machine/
PokeapiClient.MachineApi	machineRead	GET /api/v2/machine/{id}/
PokeapiClient.MoveApi	moveList	GET /api/v2/move/
PokeapiClient.MoveApi	moveRead	GET /api/v2/move/{id}/
PokeapiClient.MoveAilmentApi	moveAilmentList	GET /api/v2/move-ailment/
PokeapiClient.MoveAilmentApi	moveAilmentRead	GET /api/v2/move-ailment/{id}/
PokeapiClient.MoveBattleStyleApi	moveBattleStyleList	GET /api/v2/move-battle-style/
PokeapiClient.MoveBattleStyleApi	moveBattleStyleRead	GET /api/v2/move-battle-style/{id}/
PokeapiClient.MoveCategoryApi	moveCategoryList	GET /api/v2/move-category/
PokeapiClient.MoveCategoryApi	moveCategoryRead	GET /api/v2/move-category/{id}/
PokeapiClient.MoveDamageClassApi	moveDamageClassList	GET /api/v2/move-damage-class/
PokeapiClient.MoveDamageClassApi	moveDamageClassRead	GET /api/v2/move-damage-class/{id}/
PokeapiClient.MoveLearnMethodApi	moveLearnMethodList	GET /api/v2/move-learn-method/
PokeapiClient.MoveLearnMethodApi	moveLearnMethodRead	GET /api/v2/move-learn-method/{id}/
PokeapiClient.MoveTargetApi	moveTargetList	GET /api/v2/move-target/
PokeapiClient.MoveTargetApi	moveTargetRead	GET /api/v2/move-target/{id}/
PokeapiClient.NatureApi	natureList	GET /api/v2/nature/
PokeapiClient.NatureApi	natureRead	GET /api/v2/nature/{id}/
PokeapiClient.PalParkAreaApi	palParkAreaList	GET /api/v2/pal-park-area/
PokeapiClient.PalParkAreaApi	palParkAreaRead	GET /api/v2/pal-park-area/{id}/
PokeapiClient.PokeathlonStatApi	pokeathlonStatList	GET /api/v2/pokeathlon-stat/
PokeapiClient.PokeathlonStatApi	pokeathlonStatRead	GET /api/v2/pokeathlon-stat/{id}/
PokeapiClient.PokedexApi	pokedexList	GET /api/v2/pokedex/
PokeapiClient.PokedexApi	pokedexRead	GET /api/v2/pokedex/{id}/
PokeapiClient.PokemonApi	pokemonList	GET /api/v2/pokemon/
PokeapiClient.PokemonApi	pokemonRead	GET /api/v2/pokemon/{id}/
PokeapiClient.PokemonColorApi	pokemonColorList	GET /api/v2/pokemon-color/
PokeapiClient.PokemonColorApi	pokemonColorRead	GET /api/v2/pokemon-color/{id}/
PokeapiClient.PokemonFormApi	pokemonFormList	GET /api/v2/pokemon-form/
PokeapiClient.PokemonFormApi	pokemonFormRead	GET /api/v2/pokemon-form/{id}/
PokeapiClient.PokemonHabitatApi	pokemonHabitatList	GET /api/v2/pokemon-habitat/
PokeapiClient.PokemonHabitatApi	pokemonHabitatRead	GET /api/v2/pokemon-habitat/{id}/
PokeapiClient.PokemonShapeApi	pokemonShapeList	GET /api/v2/pokemon-shape/
PokeapiClient.PokemonShapeApi	pokemonShapeRead	GET /api/v2/pokemon-shape/{id}/
PokeapiClient.PokemonSpeciesApi	pokemonSpeciesList	GET /api/v2/pokemon-species/
PokeapiClient.PokemonSpeciesApi	pokemonSpeciesRead	GET /api/v2/pokemon-species/{id}/
PokeapiClient.RegionApi	regionList	GET /api/v2/region/
PokeapiClient.RegionApi	regionRead	GET /api/v2/region/{id}/
PokeapiClient.StatApi	statList	GET /api/v2/stat/
PokeapiClient.StatApi	statRead	GET /api/v2/stat/{id}/
PokeapiClient.SuperContestEffectApi	superContestEffectList	GET /api/v2/super-contest-effect/
PokeapiClient.SuperContestEffectApi	superContestEffectRead	GET /api/v2/super-contest-effect/{id}/
PokeapiClient.TypeApi	typeList	GET /api/v2/type/
PokeapiClient.TypeApi	typeRead	GET /api/v2/type/{id}/
PokeapiClient.VersionApi	versionList	GET /api/v2/version/
PokeapiClient.VersionApi	versionRead	GET /api/v2/version/{id}/
PokeapiClient.VersionGroupApi	versionGroupList	GET /api/v2/version-group/
PokeapiClient.VersionGroupApi	versionGroupRead	GET /api/v2/version-group/{id}/

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.