pokeapi_client 1.2.0 → 2.0.0

data/docs/EvolutionApi.md

@@ -0,0 +1,323 @@
+# PokeApiClient::EvolutionApi
+
+All URIs are relative to *https://pokeapi.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**evolution_chain_list**](EvolutionApi.md#evolution_chain_list) | **GET** /api/v2/evolution-chain/ | List evolution chains |
+| [**evolution_chain_retrieve**](EvolutionApi.md#evolution_chain_retrieve) | **GET** /api/v2/evolution-chain/{id}/ | Get evolution chain |
+| [**evolution_trigger_list**](EvolutionApi.md#evolution_trigger_list) | **GET** /api/v2/evolution-trigger/ | List evolution triggers |
+| [**evolution_trigger_retrieve**](EvolutionApi.md#evolution_trigger_retrieve) | **GET** /api/v2/evolution-trigger/{id}/ | Get evolution trigger |
+
+
+## evolution_chain_list
+
+> <PaginatedEvolutionChainSummaryList> evolution_chain_list(opts)
+
+List evolution chains
+
+Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+# setup authorization
+PokeApiClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: cookieAuth
+  config.api_key['sessionid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['sessionid'] = 'Bearer'
+end
+
+api_instance = PokeApiClient::EvolutionApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  q: 'q_example' # String | > Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the `name` property. 
+}
+
+begin
+  # List evolution chains
+  result = api_instance.evolution_chain_list(opts)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling EvolutionApi->evolution_chain_list: #{e}"
+end
+```
+
+#### Using the evolution_chain_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedEvolutionChainSummaryList>, Integer, Hash)> evolution_chain_list_with_http_info(opts)
+
+```ruby
+begin
+  # List evolution chains
+  data, status_code, headers = api_instance.evolution_chain_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedEvolutionChainSummaryList>
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling EvolutionApi->evolution_chain_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
+| **q** | **String** | &gt; Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the &#x60;name&#x60; property.  | [optional] |
+
+### Return type
+
+[**PaginatedEvolutionChainSummaryList**](PaginatedEvolutionChainSummaryList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## evolution_chain_retrieve
+
+> <EvolutionChainDetail> evolution_chain_retrieve(id)
+
+Get evolution chain
+
+Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+# setup authorization
+PokeApiClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: cookieAuth
+  config.api_key['sessionid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['sessionid'] = 'Bearer'
+end
+
+api_instance = PokeApiClient::EvolutionApi.new
+id = 'id_example' # String | This parameter can be a string or an integer.
+
+begin
+  # Get evolution chain
+  result = api_instance.evolution_chain_retrieve(id)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling EvolutionApi->evolution_chain_retrieve: #{e}"
+end
+```
+
+#### Using the evolution_chain_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EvolutionChainDetail>, Integer, Hash)> evolution_chain_retrieve_with_http_info(id)
+
+```ruby
+begin
+  # Get evolution chain
+  data, status_code, headers = api_instance.evolution_chain_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EvolutionChainDetail>
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling EvolutionApi->evolution_chain_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | This parameter can be a string or an integer. |  |
+
+### Return type
+
+[**EvolutionChainDetail**](EvolutionChainDetail.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## evolution_trigger_list
+
+> <PaginatedEvolutionTriggerSummaryList> evolution_trigger_list(opts)
+
+List evolution triggers
+
+Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+# setup authorization
+PokeApiClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: cookieAuth
+  config.api_key['sessionid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['sessionid'] = 'Bearer'
+end
+
+api_instance = PokeApiClient::EvolutionApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  q: 'q_example' # String | > Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the `name` property. 
+}
+
+begin
+  # List evolution triggers
+  result = api_instance.evolution_trigger_list(opts)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling EvolutionApi->evolution_trigger_list: #{e}"
+end
+```
+
+#### Using the evolution_trigger_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedEvolutionTriggerSummaryList>, Integer, Hash)> evolution_trigger_list_with_http_info(opts)
+
+```ruby
+begin
+  # List evolution triggers
+  data, status_code, headers = api_instance.evolution_trigger_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedEvolutionTriggerSummaryList>
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling EvolutionApi->evolution_trigger_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
+| **q** | **String** | &gt; Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the &#x60;name&#x60; property.  | [optional] |
+
+### Return type
+
+[**PaginatedEvolutionTriggerSummaryList**](PaginatedEvolutionTriggerSummaryList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## evolution_trigger_retrieve
+
+> <EvolutionTriggerDetail> evolution_trigger_retrieve(id)
+
+Get evolution trigger
+
+Evolution triggers are the events and conditions that cause a Pokémon to evolve. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution) for greater detail.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+# setup authorization
+PokeApiClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: cookieAuth
+  config.api_key['sessionid'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['sessionid'] = 'Bearer'
+end
+
+api_instance = PokeApiClient::EvolutionApi.new
+id = 'id_example' # String | This parameter can be a string or an integer.
+
+begin
+  # Get evolution trigger
+  result = api_instance.evolution_trigger_retrieve(id)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling EvolutionApi->evolution_trigger_retrieve: #{e}"
+end
+```
+
+#### Using the evolution_trigger_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EvolutionTriggerDetail>, Integer, Hash)> evolution_trigger_retrieve_with_http_info(id)
+
+```ruby
+begin
+  # Get evolution trigger
+  data, status_code, headers = api_instance.evolution_trigger_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EvolutionTriggerDetail>
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling EvolutionApi->evolution_trigger_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | This parameter can be a string or an integer. |  |
+
+### Return type
+
+[**EvolutionTriggerDetail**](EvolutionTriggerDetail.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [cookieAuth](../README.md#cookieAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/EvolutionChainDetail.md

@@ -0,0 +1,22 @@
+# PokeApiClient::EvolutionChainDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **baby_trigger_item** | [**ItemSummary**](ItemSummary.md) |  |  |
+| **chain** | [**EvolutionChainDetailChain**](EvolutionChainDetailChain.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::EvolutionChainDetail.new(
+  id: null,
+  baby_trigger_item: null,
+  chain: null
+)
+```
+

data/docs/EvolutionChainDetailChain.md

@@ -0,0 +1,24 @@
+# PokeApiClient::EvolutionChainDetailChain
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **evolution_details** | **Array<Object>** |  |  |
+| **evolves_to** | [**Array<EvolutionChainDetailChainEvolvesToInner>**](EvolutionChainDetailChainEvolvesToInner.md) |  |  |
+| **is_baby** | **Boolean** |  |  |
+| **species** | [**AbilityDetailPokemonInnerPokemon**](AbilityDetailPokemonInnerPokemon.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::EvolutionChainDetailChain.new(
+  evolution_details: null,
+  evolves_to: null,
+  is_baby: null,
+  species: null
+)
+```
+

data/docs/EvolutionChainDetailChainEvolvesToInner.md

@@ -0,0 +1,22 @@
+# PokeApiClient::EvolutionChainDetailChainEvolvesToInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **evolution_details** | [**Array<EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInner>**](EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInner.md) |  |  |
+| **is_baby** | **Boolean** |  |  |
+| **species** | [**AbilityDetailPokemonInnerPokemon**](AbilityDetailPokemonInnerPokemon.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::EvolutionChainDetailChainEvolvesToInner.new(
+  evolution_details: null,
+  is_baby: null,
+  species: null
+)
+```
+

data/docs/EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInner.md

@@ -0,0 +1,52 @@
+# PokeApiClient::EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gender** | [**EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender**](EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender.md) |  |  |
+| **held_item** | [**EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender**](EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender.md) |  |  |
+| **item** | [**EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender**](EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender.md) |  |  |
+| **known_move** | **Object** |  |  |
+| **known_move_type** | **Object** |  |  |
+| **location** | [**EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender**](EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender.md) |  |  |
+| **min_affection** | **Integer** |  |  |
+| **min_beauty** | **Integer** |  |  |
+| **min_happiness** | **Integer** |  |  |
+| **min_level** | **Integer** |  |  |
+| **needs_overworld_rain** | **Boolean** |  |  |
+| **party_species** | **String** |  |  |
+| **party_type** | **String** |  |  |
+| **relative_physical_stats** | **String** |  |  |
+| **time_of_day** | **String** |  |  |
+| **trade_species** | **String** |  |  |
+| **trigger** | [**AbilityDetailPokemonInnerPokemon**](AbilityDetailPokemonInnerPokemon.md) |  |  |
+| **turn_upside_down** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInner.new(
+  gender: null,
+  held_item: null,
+  item: null,
+  known_move: null,
+  known_move_type: null,
+  location: null,
+  min_affection: null,
+  min_beauty: null,
+  min_happiness: null,
+  min_level: null,
+  needs_overworld_rain: null,
+  party_species: null,
+  party_type: null,
+  relative_physical_stats: null,
+  time_of_day: null,
+  trade_species: null,
+  trigger: null,
+  turn_upside_down: null
+)
+```
+

data/docs/EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender.md

@@ -0,0 +1,20 @@
+# PokeApiClient::EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::EvolutionChainDetailChainEvolvesToInnerEvolutionDetailsInnerGender.new(
+  name: null,
+  url: null
+)
+```
+

data/docs/EvolutionChainSummary.md

@@ -0,0 +1,18 @@
+# PokeApiClient::EvolutionChainSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::EvolutionChainSummary.new(
+  url: null
+)
+```
+

data/docs/EvolutionTriggerDetail.md

@@ -0,0 +1,24 @@
+# PokeApiClient::EvolutionTriggerDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **name** | **String** |  |  |
+| **names** | [**Array<EvolutionTriggerName>**](EvolutionTriggerName.md) |  |  |
+| **pokemon_species** | [**Array<AbilityDetailPokemonInnerPokemon>**](AbilityDetailPokemonInnerPokemon.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::EvolutionTriggerDetail.new(
+  id: null,
+  name: null,
+  names: null,
+  pokemon_species: null
+)
+```
+

data/docs/EvolutionTriggerName.md

@@ -0,0 +1,20 @@
+# PokeApiClient::EvolutionTriggerName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **language** | [**LanguageSummary**](LanguageSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::EvolutionTriggerName.new(
+  name: null,
+  language: null
+)
+```
+

data/docs/EvolutionTriggerSummary.md

@@ -0,0 +1,20 @@
+# PokeApiClient::EvolutionTriggerSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::EvolutionTriggerSummary.new(
+  name: null,
+  url: null
+)
+```
+

data/docs/Experience.md

@@ -0,0 +1,20 @@
+# PokeApiClient::Experience
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **level** | **Integer** |  |  |
+| **experience** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::Experience.new(
+  level: null,
+  experience: null
+)
+```
+